Class DependScanner

    • Field Detail

      • DEFAULT_ANALYZER_CLASS

        public static final java.lang.String DEFAULT_ANALYZER_CLASS
        The name of the analyzer to use by default.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DependScanner

        public DependScanner​(DirectoryScanner parentScanner)
        Create a DependScanner, using the given scanner to provide the basic set of files from which class files come.
        Parameters:
        parentScanner - the DirectoryScanner which returns the files from which class files must come.
    • Method Detail

      • setRootClasses

        public void setRootClasses​(java.util.Vector<java.lang.String> rootClasses)
        Sets the root classes to be used to drive the scan.
        Parameters:
        rootClasses - the rootClasses to be used for this scan.
      • scan

        public void scan()
                  throws java.lang.IllegalStateException
        Scans the base directory for files on which baseClass depends.
        Specified by:
        scan in interface FileScanner
        Overrides:
        scan in class DirectoryScanner
        Throws:
        java.lang.IllegalStateException - when basedir was set incorrectly.
      • getExcludedDirectories

        public java.lang.String[] getExcludedDirectories()
        Description copied from class: DirectoryScanner
        Return the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns. The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.
        Specified by:
        getExcludedDirectories in interface FileScanner
        Overrides:
        getExcludedDirectories in class DirectoryScanner
        Returns:
        the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.
        See Also:
        .
      • getExcludedFiles

        public java.lang.String[] getExcludedFiles()
        Description copied from class: DirectoryScanner
        Return the names of the files which matched at least one of the include patterns and at least one of the exclude patterns. The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.
        Specified by:
        getExcludedFiles in interface FileScanner
        Overrides:
        getExcludedFiles in class DirectoryScanner
        Returns:
        the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.
        See Also:
        .
      • getIncludedDirectories

        public java.lang.String[] getIncludedDirectories()
        Description copied from class: DirectoryScanner
        Return the names of the directories which matched at least one of the include patterns and none of the exclude patterns. The names are relative to the base directory.
        Specified by:
        getIncludedDirectories in interface FileScanner
        Overrides:
        getIncludedDirectories in class DirectoryScanner
        Returns:
        the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
        See Also:
        .
      • getNotIncludedDirectories

        public java.lang.String[] getNotIncludedDirectories()
        Description copied from class: DirectoryScanner
        Return the names of the directories which matched none of the include patterns. The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.
        Specified by:
        getNotIncludedDirectories in interface FileScanner
        Overrides:
        getNotIncludedDirectories in class DirectoryScanner
        Returns:
        the names of the directories which matched none of the include patterns.
        See Also:
        .
      • getNotIncludedFiles

        public java.lang.String[] getNotIncludedFiles()
        Description copied from class: DirectoryScanner
        Return the names of the files which matched none of the include patterns. The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.
        Specified by:
        getNotIncludedFiles in interface FileScanner
        Overrides:
        getNotIncludedFiles in class DirectoryScanner
        Returns:
        the names of the files which matched none of the include patterns.
        See Also:
        .
      • setExcludes

        public void setExcludes​(java.lang.String[] excludes)
        Description copied from class: DirectoryScanner
        Set the list of exclude patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.

        When a pattern ends with a '/' or '\', "**" is appended.

        Specified by:
        setExcludes in interface FileScanner
        Overrides:
        setExcludes in class DirectoryScanner
        Parameters:
        excludes - A list of exclude patterns. May be null, indicating that no files should be excluded. If a non-null list is given, all elements must be non-null.
        See Also:
        .
      • setIncludes

        public void setIncludes​(java.lang.String[] includes)
        Description copied from class: DirectoryScanner
        Set the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.

        When a pattern ends with a '/' or '\', "**" is appended.

        Specified by:
        setIncludes in interface FileScanner
        Overrides:
        setIncludes in class DirectoryScanner
        Parameters:
        includes - A list of include patterns. May be null, indicating that all files should be included. If a non-null list is given, all elements must be non-null.
        See Also:
        .
      • setCaseSensitive

        public void setCaseSensitive​(boolean isCaseSensitive)
        Description copied from class: DirectoryScanner
        Set whether or not include and exclude patterns are matched in a case sensitive way.
        Specified by:
        setCaseSensitive in interface FileScanner
        Overrides:
        setCaseSensitive in class DirectoryScanner
        Parameters:
        isCaseSensitive - whether or not the file system should be regarded as a case sensitive one.
        See Also:
        .
      • addBasedir

        public void addBasedir​(java.io.File baseDir)