Class DependScanner
- java.lang.Object
- 
- org.apache.tools.ant.DirectoryScanner
- 
- org.apache.tools.ant.types.optional.depend.DependScanner
 
 
- 
- All Implemented Interfaces:
- FileScanner,- ResourceFactory,- SelectorScanner
 
 public class DependScanner extends DirectoryScanner DirectoryScanner for finding class dependencies.
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringDEFAULT_ANALYZER_CLASSThe name of the analyzer to use by default.- 
Fields inherited from class org.apache.tools.ant.DirectoryScannerbasedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
 
- 
 - 
Constructor SummaryConstructors Constructor Description DependScanner(DirectoryScanner parentScanner)Create a DependScanner, using the given scanner to provide the basic set of files from which class files come.
 - 
Method SummaryModifier and Type Method Description voidaddBasedir(java.io.File baseDir)voidaddDefaultExcludes()Add default exclusions to the current exclusions set.java.lang.String[]getExcludedDirectories()Return the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.java.lang.String[]getExcludedFiles()Return the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.java.lang.String[]getIncludedDirectories()Return the names of the directories which matched at least one of the include patterns and none of the exclude patterns.intgetIncludedDirsCount()Return the count of included directories.java.lang.String[]getIncludedFiles()Get the names of the class files on which baseClass depends.intgetIncludedFilesCount()Return the count of included files.java.lang.String[]getNotIncludedDirectories()Return the names of the directories which matched none of the include patterns.java.lang.String[]getNotIncludedFiles()Return the names of the files which matched none of the include patterns.voidscan()Scans the base directory for files on which baseClass depends.voidsetCaseSensitive(boolean isCaseSensitive)Set whether or not include and exclude patterns are matched in a case sensitive way.voidsetExcludes(java.lang.String[] excludes)Set the list of exclude patterns to use.voidsetIncludes(java.lang.String[] includes)Set the list of include patterns to use.voidsetRootClasses(java.util.Vector<java.lang.String> rootClasses)Sets the root classes to be used to drive the scan.- 
Methods inherited from class org.apache.tools.ant.DirectoryScanneraddDefaultExclude, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getNotFollowedSymlinks, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setErrorOnMissingDir, setFollowSymlinks, setMaxLevelsOfSymlinks, setSelectors, slowScan
 
- 
 
- 
- 
- 
Field Detail- 
DEFAULT_ANALYZER_CLASSpublic static final java.lang.String DEFAULT_ANALYZER_CLASS The name of the analyzer to use by default.- See Also:
- Constant Field Values
 
 
- 
 - 
Constructor Detail- 
DependScannerpublic 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- 
setRootClassespublic 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.
 
 - 
getIncludedFilespublic java.lang.String[] getIncludedFiles() Get the names of the class files on which baseClass depends.- Specified by:
- getIncludedFilesin interface- FileScanner
- Overrides:
- getIncludedFilesin class- DirectoryScanner
- Returns:
- the names of the files.
 
 - 
getIncludedFilesCountpublic int getIncludedFilesCount() Return the count of included files..- Overrides:
- getIncludedFilesCountin class- DirectoryScanner
- Returns:
- int.
 
 - 
scanpublic void scan() throws java.lang.IllegalStateExceptionScans the base directory for files on which baseClass depends.- Specified by:
- scanin interface- FileScanner
- Overrides:
- scanin class- DirectoryScanner
- Throws:
- java.lang.IllegalStateException- when basedir was set incorrectly.
 
 - 
addDefaultExcludespublic void addDefaultExcludes() Description copied from class:DirectoryScannerAdd default exclusions to the current exclusions set.- Specified by:
- addDefaultExcludesin interface- FileScanner
- Overrides:
- addDefaultExcludesin class- DirectoryScanner
- See Also:
- DirectoryScanner.addDefaultExcludes()
 
 - 
getExcludedDirectoriespublic java.lang.String[] getExcludedDirectories() Description copied from class:DirectoryScannerReturn 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:
- getExcludedDirectoriesin interface- FileScanner
- Overrides:
- getExcludedDirectoriesin 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:
- .
 
 - 
getExcludedFilespublic java.lang.String[] getExcludedFiles() Description copied from class:DirectoryScannerReturn 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:
- getExcludedFilesin interface- FileScanner
- Overrides:
- getExcludedFilesin 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:
- .
 
 - 
getIncludedDirectoriespublic java.lang.String[] getIncludedDirectories() Description copied from class:DirectoryScannerReturn 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:
- getIncludedDirectoriesin interface- FileScanner
- Overrides:
- getIncludedDirectoriesin 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:
- .
 
 - 
getIncludedDirsCountpublic int getIncludedDirsCount() Description copied from class:DirectoryScannerReturn the count of included directories.- Overrides:
- getIncludedDirsCountin class- DirectoryScanner
- Returns:
- int.
- See Also:
- .
 
 - 
getNotIncludedDirectoriespublic java.lang.String[] getNotIncludedDirectories() Description copied from class:DirectoryScannerReturn 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:
- getNotIncludedDirectoriesin interface- FileScanner
- Overrides:
- getNotIncludedDirectoriesin class- DirectoryScanner
- Returns:
- the names of the directories which matched none of the include patterns.
- See Also:
- .
 
 - 
getNotIncludedFilespublic java.lang.String[] getNotIncludedFiles() Description copied from class:DirectoryScannerReturn 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:
- getNotIncludedFilesin interface- FileScanner
- Overrides:
- getNotIncludedFilesin class- DirectoryScanner
- Returns:
- the names of the files which matched none of the include patterns.
- See Also:
- .
 
 - 
setExcludespublic void setExcludes(java.lang.String[] excludes) Description copied from class:DirectoryScannerSet the list of exclude patterns to use. All '/' and '\' characters are replaced byFile.separatorChar, so the separator used need not matchFile.separatorChar.When a pattern ends with a '/' or '\', "**" is appended. - Specified by:
- setExcludesin interface- FileScanner
- Overrides:
- setExcludesin class- DirectoryScanner
- Parameters:
- excludes- A list of exclude patterns. May be- null, indicating that no files should be excluded. If a non-- nulllist is given, all elements must be non-- null.
- See Also:
- .
 
 - 
setIncludespublic void setIncludes(java.lang.String[] includes) Description copied from class:DirectoryScannerSet the list of include patterns to use. All '/' and '\' characters are replaced byFile.separatorChar, so the separator used need not matchFile.separatorChar.When a pattern ends with a '/' or '\', "**" is appended. - Specified by:
- setIncludesin interface- FileScanner
- Overrides:
- setIncludesin class- DirectoryScanner
- Parameters:
- includes- A list of include patterns. May be- null, indicating that all files should be included. If a non-- nulllist is given, all elements must be non-- null.
- See Also:
- .
 
 - 
setCaseSensitivepublic void setCaseSensitive(boolean isCaseSensitive) Description copied from class:DirectoryScannerSet whether or not include and exclude patterns are matched in a case sensitive way.- Specified by:
- setCaseSensitivein interface- FileScanner
- Overrides:
- setCaseSensitivein class- DirectoryScanner
- Parameters:
- isCaseSensitive- whether or not the file system should be regarded as a case sensitive one.
- See Also:
- .
 
 - 
addBasedirpublic void addBasedir(java.io.File baseDir) 
 
- 
 
-