![]()
|
DirectoryScanner (Apache Ant API)
org.apache.tools.ant
|
Field Summary | |
protected java.io.File |
basedir
The base directory to be scanned. |
protected static java.lang.String[] |
DEFAULTEXCLUDES
Patterns which should be excluded by default. |
protected java.util.Vector |
dirsDeselected
The directories which matched at least one include and no excludes but which a selector discarded. |
protected java.util.Vector |
dirsExcluded
The directories which matched at least one include and at least one exclude. |
protected java.util.Vector |
dirsIncluded
The directories which matched at least one include and no excludes and were selected. |
protected java.util.Vector |
dirsNotIncluded
The directories which were found and did not match any includes. |
protected boolean |
everythingIncluded
Whether or not everything tested so far has been included. |
protected java.lang.String[] |
excludes
The patterns for the files to be excluded. |
protected java.util.Vector |
filesDeselected
The files which matched at least one include and no excludes and which a selector discarded. |
protected java.util.Vector |
filesExcluded
The files which matched at least one include and at least one exclude. |
protected java.util.Vector |
filesIncluded
The files which matched at least one include and no excludes and were selected. |
protected java.util.Vector |
filesNotIncluded
The files which did not match any includes or selectors. |
protected boolean |
haveSlowResults
Whether or not our results were built by a slow scan. |
protected java.lang.String[] |
includes
The patterns for the files to be included. |
protected boolean |
isCaseSensitive
Whether or not the file system should be treated as a case sensitive one. |
protected FileSelector[] |
selectors
Selectors that will filter which files are in our candidate list. |
Constructor Summary | |
DirectoryScanner()
Sole constructor. |
Method Summary | |
void |
addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
protected boolean |
couldHoldIncluded(java.lang.String name)
Tests whether or not a name matches the start of at least one include pattern. |
java.io.File |
getBasedir()
Returns the base directory to be scanned. |
java.lang.String[] |
getDeselectedDirectories()
Returns the names of the directories which were selected. |
java.lang.String[] |
getDeselectedFiles()
Returns the names of the files which were selected. |
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()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns. |
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. |
boolean |
isEverythingIncluded()
Returns whether or not the scanner has included all the files or directories it has come across so far. |
protected boolean |
isExcluded(java.lang.String name)
Tests whether or not a name matches against at least one exclude pattern. |
protected boolean |
isIncluded(java.lang.String name)
Tests whether or not a name matches against at least one include pattern. |
protected boolean |
isSelected(java.lang.String name,
java.io.File file)
Tests whether a name should be selected. |
static boolean |
match(java.lang.String pattern,
java.lang.String str)
Tests whether or not a string matches against a pattern. |
protected static boolean |
match(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)
Tests whether or not a string matches against a pattern. |
protected static boolean |
matchPath(java.lang.String pattern,
java.lang.String str)
Tests whether or not a given path matches a given pattern. |
protected static boolean |
matchPath(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)
Tests whether or not a given path matches a given pattern. |
protected static boolean |
matchPatternStart(java.lang.String pattern,
java.lang.String str)
Tests whether or not a given path matches the start of a given pattern up to the first "**". |
protected static boolean |
matchPatternStart(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)
Tests whether or not a given path matches the start of a given pattern up to the first "**". |
void |
scan()
Scans the base directory for files which match at least one include pattern and don't match any exclude patterns. |
protected void |
scandir(java.io.File dir,
java.lang.String vpath,
boolean fast)
Scans the given directory for files and directories. |
void |
setBasedir(java.io.File basedir)
Sets the base directory to be scanned. |
void |
setBasedir(java.lang.String basedir)
Sets the base directory to be scanned. |
void |
setCaseSensitive(boolean isCaseSensitive)
Sets whether or not the file system should be regarded as case sensitive. |
void |
setExcludes(java.lang.String[] excludes)
Sets the list of exclude patterns to use. |
void |
setFollowSymlinks(boolean followSymlinks)
Sets whether or not symbolic links should be followed. |
void |
setIncludes(java.lang.String[] includes)
Sets the list of include patterns to use. |
void |
setSelectors(FileSelector[] selectors)
Sets the selectors that will select the filelist. |
protected void |
slowScan()
Top level invocation for a slow scan. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String[] DEFAULTEXCLUDES
addDefaultExcludes()
protected java.io.File basedir
protected java.lang.String[] includes
protected java.lang.String[] excludes
protected FileSelector[] selectors
protected java.util.Vector filesIncluded
protected java.util.Vector filesNotIncluded
protected java.util.Vector filesExcluded
protected java.util.Vector dirsIncluded
protected java.util.Vector dirsNotIncluded
protected java.util.Vector dirsExcluded
protected java.util.Vector filesDeselected
protected java.util.Vector dirsDeselected
protected boolean haveSlowResults
protected boolean isCaseSensitive
protected boolean everythingIncluded
Constructor Detail |
public DirectoryScanner()
Method Detail |
protected static boolean matchPatternStart(java.lang.String pattern, java.lang.String str)
This is not a general purpose test and should only be used if you
can live with false positives. For example, pattern=**\a
and str=b
will yield true
.
pattern
- The pattern to match against. Must not be
null
.str
- The path to match, as a String. Must not be
null
.
protected static boolean matchPatternStart(java.lang.String pattern, java.lang.String str, boolean isCaseSensitive)
This is not a general purpose test and should only be used if you
can live with false positives. For example, pattern=**\a
and str=b
will yield true
.
pattern
- The pattern to match against. Must not be
null
.str
- The path to match, as a String. Must not be
null
.isCaseSensitive
- Whether or not matching should be performed
case sensitively.
protected static boolean matchPath(java.lang.String pattern, java.lang.String str)
pattern
- The pattern to match against. Must not be
null
.str
- The path to match, as a String. Must not be
null
.
true
if the pattern matches against the string,
or false
otherwise.protected static boolean matchPath(java.lang.String pattern, java.lang.String str, boolean isCaseSensitive)
pattern
- The pattern to match against. Must not be
null
.str
- The path to match, as a String. Must not be
null
.isCaseSensitive
- Whether or not matching should be performed
case sensitively.
true
if the pattern matches against the string,
or false
otherwise.public static boolean match(java.lang.String pattern, java.lang.String str)
pattern
- The pattern to match against.
Must not be null
.str
- The string which must be matched against the pattern.
Must not be null
.
true
if the string matches against the pattern,
or false
otherwise.protected static boolean match(java.lang.String pattern, java.lang.String str, boolean isCaseSensitive)
pattern
- The pattern to match against.
Must not be null
.str
- The string which must be matched against the pattern.
Must not be null
.isCaseSensitive
- Whether or not matching should be performed
case sensitively.
true
if the string matches against the pattern,
or false
otherwise.public void setBasedir(java.lang.String basedir)
File.separatorChar
, so the separator used need not match
File.separatorChar
.
setBasedir
in interface FileScanner
basedir
- The base directory to scan.
Must not be null
.public void setBasedir(java.io.File basedir)
setBasedir
in interface FileScanner
basedir
- The base directory for scanning.
Should not be null
.public java.io.File getBasedir()
getBasedir
in interface FileScanner
public void setCaseSensitive(boolean isCaseSensitive)
setCaseSensitive
in interface FileScanner
isCaseSensitive
- whether or not the file system should be
regarded as a case sensitive onepublic void setFollowSymlinks(boolean followSymlinks)
followSymlinks
- whether or not symbolic links should be followedpublic void setIncludes(java.lang.String[] includes)
File.separatorChar
, so the separator used
need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
setIncludes
in interface FileScanner
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
.public void setExcludes(java.lang.String[] excludes)
File.separatorChar
, so the separator used
need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
setExcludes
in interface FileScanner
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
.public void setSelectors(FileSelector[] selectors)
setSelectors
in interface SelectorScanner
selectors
- specifies the selectors to be invoked on a scanpublic boolean isEverythingIncluded()
true
if all files and directories which have
been found so far have been included.public void scan() throws java.lang.IllegalStateException
scan
in interface FileScanner
java.lang.IllegalStateException
- if the base directory was set
incorrectly (i.e. if it is null
, doesn't exist,
or isn't a directory).protected void slowScan()
Returns immediately if a slow scan has already been completed.
protected void scandir(java.io.File dir, java.lang.String vpath, boolean fast)
dir
- The directory to scan. Must not be null
.vpath
- The path relative to the base directory (needed to
prevent problems with an absolute path when using
dir). Must not be null
.fast
- Whether or not this call is part of a fast scan.filesIncluded
,
filesNotIncluded
,
filesExcluded
,
dirsIncluded
,
dirsNotIncluded
,
dirsExcluded
,
slowScan()
protected boolean isIncluded(java.lang.String name)
name
- The name to match. Must not be null
.
true
when the name matches against at least one
include pattern, or false
otherwise.protected boolean couldHoldIncluded(java.lang.String name)
name
- The name to match. Must not be null
.
true
when the name matches against the start of at
least one include pattern, or false
otherwise.protected boolean isExcluded(java.lang.String name)
name
- The name to match. Must not be null
.
true
when the name matches against at least one
exclude pattern, or false
otherwise.protected boolean isSelected(java.lang.String name, java.io.File file)
name
- the filename to check for selectingfile
- the java.io.File object for this filename
false
when the selectors says that the file
should not be selected, true
otherwise.public java.lang.String[] getIncludedFiles()
getIncludedFiles
in interface FileScanner
public java.lang.String[] getNotIncludedFiles()
getNotIncludedFiles
in interface FileScanner
slowScan()
public java.lang.String[] getExcludedFiles()
getExcludedFiles
in interface FileScanner
slowScan()
public java.lang.String[] getDeselectedFiles()
getDeselectedFiles
in interface SelectorScanner
slowScan()
public java.lang.String[] getIncludedDirectories()
getIncludedDirectories
in interface FileScanner
public java.lang.String[] getNotIncludedDirectories()
getNotIncludedDirectories
in interface FileScanner
slowScan()
public java.lang.String[] getExcludedDirectories()
getExcludedDirectories
in interface FileScanner
slowScan()
public java.lang.String[] getDeselectedDirectories()
getDeselectedDirectories
in interface SelectorScanner
slowScan()
public void addDefaultExcludes()
addDefaultExcludes
in interface FileScanner
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |