|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--org.apache.tools.ant.DirectoryScanner
|
+--org.apache.tools.ant.types.optional.depend.DependScanner
An interface used to describe the actions required by any type of directory scanner.
| Field Summary | |
static java.lang.String |
DEFAULT_ANALYZER_CLASS
The name of the analyzer to use by default. |
| Fields inherited from class org.apache.tools.ant.DirectoryScanner |
basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, selectors |
| Constructor Summary | |
DependScanner(DirectoryScanner parentScanner)
Create a DependScanner, using the given scanner to provide the basic set of files from which class files come. |
|
| Method Summary | |
void |
addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
java.io.File |
getBasedir()
Gets the basedir that is used for scanning. |
java.lang.String[] |
getExcludedDirectories()
Returns 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()
Returns 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()
Returns the names of the directories which matched at least one of the include patterns and none of the exclude patterns. |
java.lang.String[] |
getIncludedFiles()
Get the names of the class files, baseClass depends on |
java.lang.String[] |
getNotIncludedDirectories()
Returns the names of the directories which matched none of the include patterns. |
java.lang.String[] |
getNotIncludedFiles()
Returns the names of the files which matched none of the include patterns. |
void |
scan()
Scans the base directory for files that baseClass depends on |
void |
setBasedir(java.io.File basedir)
Sets the basedir for scanning. |
void |
setCaseSensitive(boolean isCaseSensitive)
Sets whether or not include and exclude patterns are matched in a case sensitive way |
void |
setExcludes(java.lang.String[] excludes)
Sets the list of exclude patterns to use. |
void |
setIncludes(java.lang.String[] includes)
Sets the list of include patterns to use. |
void |
setRootClasses(java.util.Vector rootClasses)
Sets the root classes to be used to drive the scan. |
| Methods inherited from class org.apache.tools.ant.DirectoryScanner |
addDefaultExclude, couldHoldIncluded, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setFollowSymlinks, setSelectors, slowScan |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final java.lang.String DEFAULT_ANALYZER_CLASS
| Constructor Detail |
public DependScanner(DirectoryScanner parentScanner)
parentScanner - the DirectoryScanner which returns the files from
which class files must come.| Method Detail |
public void setBasedir(java.io.File basedir)
setBasedir in interface FileScannersetBasedir in class DirectoryScannerbasedir - the basedir for scanningpublic java.io.File getBasedir()
getBasedir in interface FileScannergetBasedir in class DirectoryScannerpublic void setRootClasses(java.util.Vector rootClasses)
rootClasses - the rootClasses to be used for this scanpublic java.lang.String[] getIncludedFiles()
getIncludedFiles in interface FileScannergetIncludedFiles in class DirectoryScanner
public void scan()
throws java.lang.IllegalStateException
scan in interface FileScannerscan in class DirectoryScannerjava.lang.IllegalStateException - when basedir was set incorreclypublic void addDefaultExcludes()
DirectoryScanner
addDefaultExcludes in interface FileScanneraddDefaultExcludes in class DirectoryScannerDirectoryScanner.addDefaultExcludes()public java.lang.String[] getExcludedDirectories()
DirectoryScanner
getExcludedDirectories in interface FileScannergetExcludedDirectories in class DirectoryScannerDirectoryScanner.getExcludedDirectories()public java.lang.String[] getExcludedFiles()
DirectoryScanner
getExcludedFiles in interface FileScannergetExcludedFiles in class DirectoryScannerDirectoryScanner.getExcludedFiles()public java.lang.String[] getIncludedDirectories()
DirectoryScanner
getIncludedDirectories in interface FileScannergetIncludedDirectories in class DirectoryScannerDirectoryScanner.getIncludedDirectories()public java.lang.String[] getNotIncludedDirectories()
DirectoryScanner
getNotIncludedDirectories in interface FileScannergetNotIncludedDirectories in class DirectoryScannerDirectoryScanner.getNotIncludedDirectories()public java.lang.String[] getNotIncludedFiles()
DirectoryScanner
getNotIncludedFiles in interface FileScannergetNotIncludedFiles in class DirectoryScannerDirectoryScanner.getNotIncludedFiles()public void setExcludes(java.lang.String[] excludes)
DirectoryScannerFile.separatorChar, so the separator used
need not match File.separatorChar.
When a pattern ends with a '/' or '\', "**" is appended.
setExcludes in interface FileScannersetExcludes in class DirectoryScannerexcludes - 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.DirectoryScanner.setExcludes(java.lang.String[])public void setIncludes(java.lang.String[] includes)
DirectoryScannerFile.separatorChar, so the separator used
need not match File.separatorChar.
When a pattern ends with a '/' or '\', "**" is appended.
setIncludes in interface FileScannersetIncludes in class DirectoryScannerincludes - 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.DirectoryScanner.setIncludes(java.lang.String[])public void setCaseSensitive(boolean isCaseSensitive)
DirectoryScanner
setCaseSensitive in interface FileScannersetCaseSensitive in class DirectoryScannerisCaseSensitive - whether or not the file system should be
regarded as a case sensitive oneDirectoryScanner.setCaseSensitive(boolean)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||