Interface DirectoryAnalyser

  • All Known Implementing Classes:
    DirectoryAnalyserImpl

    public interface DirectoryAnalyser
    This interface defines a directory analyser. This is the process by which the contents of a source directory are grouped together into a list of ImportableItems. Please note that this interface is not intended to have more than one implementation (DirectoryAnalyserImpl) - it exists solely for dependency injection purposes.
    Since:
    4.0
    • Field Detail

      • VERSION_SUFFIX_REGEX

        static final java.lang.String VERSION_SUFFIX_REGEX
        Regex string for the version filename suffix
        See Also:
        Constant Field Values
    • Method Detail

      • analyseDirectory

        AnalysedDirectory analyseDirectory​(ImportableItem directory,
                                           java.nio.file.DirectoryStream.Filter<java.nio.file.Path> filter)
        Analyses the given directory.
        Parameters:
        directory - The directory to analyse (note: must be a directory) (must not be null).
        Returns:
        An AnalysedDirectory object (will not be null).