|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.DirectoryScanner
Class for scanning a directory for files/directories that match a certain criteria.
These criteria consist of a set of include and exclude patterns. With these patterns, you can select which files you want to have included, and which files you want to have excluded.
The idea is simple. A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of include and exclude patterns. Only files/directories that match at least one pattern of the include pattern list, and don't match a pattern of the exclude pattern list will be placed in the list of files/directories found.
When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded.
The pattern matching is done as follows:
The name to be matched is split up in path segments. A path segment is the
name of a directory or file, which is bounded by
File.separator
('/' under UNIX, '\' under Windows).
E.g. "abc/def/ghi/xyz.java" is split up in the segments "abc", "def", "ghi"
and "xyz.java".
The same is done for the pattern against which should be matched.
Then the segments of the name and the pattern will be matched against each other. When '**' is used for a path segment in the pattern, then it matches zero or more path segments of the name.
There are special case regarding the use of File.separator
s at
the beginningof the pattern and the string to match:
When a pattern starts with a File.separator
, the string
to match must also start with a File.separator
.
When a pattern does not start with a File.separator
, the
string to match may not start with a File.separator
.
When one of these rules is not obeyed, the string will not
match.
When a name path segment is matched against a pattern path segment, the following special characters can be used: '*' matches zero or more characters, '?' matches one character.
Examples:
"**\*.class" matches all .class files/dirs in a directory tree.
"test\a??.java" matches all files/dirs which start with an 'a', then two more characters and then ".java", in a directory called test.
"**" matches everything in a directory tree.
"**\test\**\XYZ*" matches all files/dirs that start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
Example of usage:
String[] includes = {"**\\*.class"}; String[] excludes = {"modules\\*\\**"}; ds.setIncludes(includes); ds.setExcludes(excludes); ds.setBasedir(new File("test")); ds.scan(); System.out.println("FILES:"); String[] files = ds.getIncludedFiles(); for (int i = 0; i < files.length;i++) { System.out.println(files[i]); }This will scan a directory called test for .class files, but excludes all .class files in all directories under a directory called "modules"
Field Summary | |
protected java.io.File |
basedir
The base directory which should be scanned. |
protected static java.lang.String[] |
DEFAULTEXCLUDES
Patterns that should be excluded by default. |
protected java.util.Vector |
dirsExcluded
The files that where found and matched at least one includes, and also matched at least one excludes. |
protected java.util.Vector |
dirsIncluded
The directories that where found and matched at least one includes, and matched no excludes. |
protected java.util.Vector |
dirsNotIncluded
The directories that where found and did not match any includes. |
protected java.lang.String[] |
excludes
The patterns for the files that should be excluded. |
protected java.util.Vector |
filesExcluded
The files that where found and matched at least one includes, and also matched at least one excludes. |
protected java.util.Vector |
filesIncluded
The files that where found and matched at least one includes, and matched no excludes. |
protected java.util.Vector |
filesNotIncluded
The files that where found and did not match any includes. |
protected boolean |
haveSlowResults
Have the Vectors holding our results been built by a slow scan? |
protected java.lang.String[] |
includes
The patterns for the files that should be included. |
Constructor Summary | |
DirectoryScanner()
Constructor. |
Method Summary | |
void |
addDefaultExcludes()
Adds the array with default exclusions to the current exclusions set. |
protected boolean |
couldHoldIncluded(java.lang.String name)
Tests whether a name matches the start of at least one include pattern. |
java.io.File |
getBasedir()
Gets the basedir that is used for scanning. |
java.lang.String[] |
getExcludedDirectories()
Get the names of the directories that matched at least one of the include patterns, an matched also at least one of the exclude patterns. |
java.lang.String[] |
getExcludedFiles()
Get the names of the files that matched at least one of the include patterns, an matched also at least one of the exclude patterns. |
java.lang.String[] |
getIncludedDirectories()
Get the names of the directories that matched at least one of the include patterns, an matched none of the exclude patterns. |
java.lang.String[] |
getIncludedFiles()
Get the names of the files that matched at least one of the include patterns, an matched none of the exclude patterns. |
java.lang.String[] |
getNotIncludedDirectories()
Get the names of the directories that matched at none of the include patterns. |
java.lang.String[] |
getNotIncludedFiles()
Get the names of the files that matched at none of the include patterns. |
protected boolean |
isExcluded(java.lang.String name)
Tests whether a name matches against at least one exclude pattern. |
protected boolean |
isIncluded(java.lang.String name)
Tests whether a name matches against at least one include pattern. |
protected static boolean |
match(java.lang.String pattern,
java.lang.String str)
Matches a string against a pattern. |
protected static boolean |
matchPath(java.lang.String pattern,
java.lang.String str)
Matches a path against a pattern. |
protected static boolean |
matchPatternStart(java.lang.String pattern,
java.lang.String str)
Does the path match the start of this pattern up to the first "**". |
void |
scan()
Scans the base directory for files that 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 passed dir for files and directories. |
void |
setBasedir(java.io.File basedir)
Sets the basedir for scanning. |
void |
setBasedir(java.lang.String basedir)
Sets the basedir for scanning. |
void |
setExcludes(java.lang.String[] excludes)
Sets the set of exclude patterns to use. |
void |
setIncludes(java.lang.String[] includes)
Sets the set of include patterns to use. |
protected void |
slowScan()
Toplevel invocation for the 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 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 boolean haveSlowResults
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.
pattern=**\\a
and str=b
will yield true.
pattern
- the (non-null) pattern to match againststr
- the (non-null) string (path) to matchprotected static boolean matchPath(java.lang.String pattern, java.lang.String str)
pattern
- the (non-null) pattern to match againststr
- the (non-null) string (path) to matchtrue
when the pattern matches against the string.
false
otherwise.protected static boolean match(java.lang.String pattern, java.lang.String str)
pattern
- the (non-null) pattern to match againststr
- the (non-null) string that must be matched against the
patterntrue
when the string matches against the pattern,
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 (non-null) basedir for scanningpublic void setBasedir(java.io.File basedir)
setBasedir
in interface FileScanner
basedir
- the basedir for scanningpublic java.io.File getBasedir()
getBasedir
in interface FileScanner
public 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
- list of include patternspublic 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
- list of exclude patternspublic void scan()
scan
in interface FileScanner
java.lang.IllegalStateException
- when basedir was set incorreclyprotected void slowScan()
Returns immediately if a slow scan has already been requested.
protected void scandir(java.io.File dir, java.lang.String vpath, boolean fast)
dir
- the directory to scanvpath
- the path relative to the basedir (needed to prevent
problems with an absolute path when using dir)filesIncluded
,
filesNotIncluded
,
filesExcluded
,
dirsIncluded
,
dirsNotIncluded
,
dirsExcluded
protected boolean isIncluded(java.lang.String name)
name
- the name to matchtrue
when the name matches against at least one
include pattern, false
otherwise.protected boolean couldHoldIncluded(java.lang.String name)
name
- the name to matchtrue
when the name matches against at least one
include pattern, false
otherwise.protected boolean isExcluded(java.lang.String name)
name
- the name to matchtrue
when the name matches against at least one
exclude pattern, false
otherwise.public java.lang.String[] getIncludedFiles()
getIncludedFiles
in interface FileScanner
public java.lang.String[] getNotIncludedFiles()
getNotIncludedFiles
in interface FileScanner
public java.lang.String[] getExcludedFiles()
getExcludedFiles
in interface FileScanner
public java.lang.String[] getIncludedDirectories()
getIncludedDirectories
in interface FileScanner
public java.lang.String[] getNotIncludedDirectories()
getNotIncludedDirectories
in interface FileScanner
public java.lang.String[] getExcludedDirectories()
getExcludedDirectories
in interface FileScanner
public void addDefaultExcludes()
addDefaultExcludes
in interface FileScanner
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |