Class for scanning a directory for files/directories which match certain
criteria.
These criteria consist of selectors and patterns which have been specified.
With the selectors you can select which files you want to have included.
Files which are not selected are excluded. With patterns you can include
or exclude files based on their filename.
The idea is simple. A given directory is recursively scanned for all files
and directories. Each file/directory is matched against a set of selectors,
including special support for matching against filenames with include and
and exclude patterns. Only files/directories which match at least one
pattern of the include pattern list or other file selector, and don't match
any pattern of the exclude pattern list or fail to match against a required
selector 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. When
no selectors are supplied, none are applied.
The filename 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).
For example, "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.
The segments of the name and the pattern are then matched against each
other. When '**' is used for a path segment in the pattern, it matches
zero or more path segments of the name.
There is a special case regarding the use of
File.separator
s
at the beginning of 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 which start with "XYZ" and where
there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").
Case sensitivity may be turned off if necessary. By default, it is
turned on.
Example of usage:
String[] includes = {"**\\*.class"};
String[] excludes = {"modules\\*\\**"};
ds.setIncludes(includes);
ds.setExcludes(excludes);
ds.setBasedir(new File("test"));
ds.setCaseSensitive(true);
ds.scan();
System.out.println("FILES:");
String[] files = ds.getIncludedFiles();
for (int i = 0; i <32files.length; i++) {
System.out.println(files[i]);
}
This will scan a directory called test for .class files, but excludes all
files in all proper subdirectories of a directory called "modules"
DEFAULTEXCLUDES
protected static final String[] DEFAULTEXCLUDES
use the getDefaultExcludes
method instead.
Patterns which should be excluded by default.
Note that you can now add patterns to the list of default
excludes. Added patterns will not become part of this array
that has only been kept around for backwards compatibility
reasons.
basedir
protected File basedir
The base directory to be scanned.
dirsDeselected
protected Vector dirsDeselected
The directories which matched at least one include and no excludes
but which a selector discarded.
dirsExcluded
protected Vector dirsExcluded
The directories which matched at least one include and at least one
exclude.
dirsIncluded
protected Vector dirsIncluded
The directories which matched at least one include and no excludes
and were selected.
dirsNotIncluded
protected Vector dirsNotIncluded
The directories which were found and did not match any includes.
everythingIncluded
protected boolean everythingIncluded
Whether or not everything tested so far has been included.
excludes
protected String[] excludes
The patterns for the files to be excluded.
filesDeselected
protected Vector filesDeselected
The files which matched at least one include and no excludes and
which a selector discarded.
filesExcluded
protected Vector filesExcluded
The files which matched at least one include and at least
one exclude.
filesIncluded
protected Vector filesIncluded
The files which matched at least one include and no excludes
and were selected.
filesNotIncluded
protected Vector filesNotIncluded
The files which did not match any includes or selectors.
haveSlowResults
protected boolean haveSlowResults
Whether or not our results were built by a slow scan.
includes
protected String[] includes
The patterns for the files to be included.
isCaseSensitive
protected boolean isCaseSensitive
Whether or not the file system should be treated as a case sensitive
one.
selectors
protected FileSelector[] selectors
Selectors that will filter which files are in our candidate list.
addDefaultExclude
public static boolean addDefaultExclude(String s)
Add a pattern to the default excludes unless it is already a
default exclude.
s
- A string to add as an exclude pattern.
true
if the string was added;
false
if it already existed.
addDefaultExcludes
public void addDefaultExcludes()
Add default exclusions to the current exclusions set.
- addDefaultExcludes in interface FileScanner
addExcludes
public void addExcludes(String[] excludes)
Add to 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.
excludes
- A list of exclude patterns.
May be null
, in which case the
exclude patterns don't get changed at all.
clearResults
protected void clearResults()
Clear the result caches for a scan.
couldHoldIncluded
protected boolean couldHoldIncluded(String name)
Test whether or not a name matches the start of at least one include
pattern.
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.
getBasedir
public File getBasedir()
Return the base directory to be scanned.
This is the directory which is scanned recursively.
- getBasedir in interface FileScanner
- the base directory to be scanned
getDefaultExcludes
public static String[] getDefaultExcludes()
Get the list of patterns that should be excluded by default.
- An array of
String
based on the current
contents of the defaultExcludes
Vector
.
getDeselectedDirectories
public String[] getDeselectedDirectories()
Return the names of the directories which were selected out and
therefore not ultimately included.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.
- getDeselectedDirectories in interface SelectorScanner
- the names of the directories which were deselected.
getDeselectedFiles
public String[] getDeselectedFiles()
Return the names of the files which were selected out and
therefore not ultimately included.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.
- getDeselectedFiles in interface SelectorScanner
- the names of the files which were deselected.
getExcludedDirectories
public 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.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.
- getExcludedDirectories in interface FileScanner
- the names of the directories which matched at least one of the
include patterns and at least one of the exclude patterns.
getExcludedFiles
public 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.
The names are relative to the base directory. This involves
performing a slow scan if one has not already been completed.
- getExcludedFiles in interface FileScanner
- the names of the files which matched at least one of the
include patterns and at least one of the exclude patterns.
getIncludedDirectories
public String[] getIncludedDirectories()
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.
- getIncludedDirectories in interface FileScanner
- the names of the directories which matched at least one of the
include patterns and none of the exclude patterns.
getIncludedDirsCount
public int getIncludedDirsCount()
Return the count of included directories.
getIncludedFiles
public String[] getIncludedFiles()
Return the names of the files which matched at least one of the
include patterns and none of the exclude patterns.
The names are relative to the base directory.
- getIncludedFiles in interface FileScanner
- the names of the files which matched at least one of the
include patterns and none of the exclude patterns.
getIncludedFilesCount
public int getIncludedFilesCount()
Return the count of included files.
getNotIncludedDirectories
public String[] getNotIncludedDirectories()
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.
- getNotIncludedDirectories in interface FileScanner
- the names of the directories which matched none of the include
patterns.
getNotIncludedFiles
public String[] getNotIncludedFiles()
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.
- getNotIncludedFiles in interface FileScanner
- the names of the files which matched none of the include
patterns.
getResource
public Resource getResource(String name)
Get the named resource.
- getResource in interface ResourceFactory
name
- path name of the file relative to the dir attribute.
- the resource with the given name.
isCaseSensitive
public boolean isCaseSensitive()
Find out whether include exclude patterns are matched in a
case sensitive way.
- whether or not the scanning is case sensitive.
isEverythingIncluded
public boolean isEverythingIncluded()
Return whether or not the scanner has included all the files or
directories it has come across so far.
true
if all files and directories which have
been found so far have been included.
isExcluded
protected boolean isExcluded(String name)
Test whether or not a name matches against at least one exclude
pattern.
name
- The name to match. Must not be null
.
true
when the name matches against at least one
exclude pattern, or false
otherwise.
isFollowSymlinks
public boolean isFollowSymlinks()
Get whether or not a DirectoryScanner follows symbolic links.
- flag indicating whether symbolic links should be followed.
isIncluded
protected boolean isIncluded(String name)
Test whether or not a name matches against at least one include
pattern.
name
- The name to match. Must not be null
.
true
when the name matches against at least one
include pattern, or false
otherwise.
isSelected
protected boolean isSelected(String name,
File file)
Test whether a file should be selected.
name
- the filename to check for selecting.file
- the java.io.File object for this filename.
false
when the selectors says that the file
should not be selected, true
otherwise.
match
public static boolean match(String pattern,
String str)
Test whether or not a string matches against a pattern.
The pattern may contain two special characters:
'*' means zero or more characters
'?' means one and only one character
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.
match
protected static boolean match(String pattern,
String str,
boolean isCaseSensitive)
Test whether or not a string matches against a pattern.
The pattern may contain two special characters:
'*' means zero or more characters
'?' means one and only one character
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.
matchPath
protected static boolean matchPath(String pattern,
String str)
Test whether or not a given path matches a given pattern.
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.
matchPath
protected static boolean matchPath(String pattern,
String str,
boolean isCaseSensitive)
Test whether or not a given path matches a given pattern.
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.
matchPatternStart
protected static boolean matchPatternStart(String pattern,
String str)
Test whether or not a given path matches the start of a given
pattern up to the first "**".
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
.
- whether or not a given path matches the start of a given
pattern up to the first "**".
matchPatternStart
protected static boolean matchPatternStart(String pattern,
String str,
boolean isCaseSensitive)
Test whether or not a given path matches the start of a given
pattern up to the first "**".
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.
- whether or not a given path matches the start of a given
pattern up to the first "**".
removeDefaultExclude
public static boolean removeDefaultExclude(String s)
Remove a string if it is a default exclude.
s
- The string to attempt to remove.
true
if s
was a default
exclude (and thus was removed);
false
if s
was not
in the default excludes list to begin with.
resetDefaultExcludes
public static void resetDefaultExcludes()
Go back to the hardwired default exclude patterns.
scan
public void scan()
throws IllegalStateException
Scan the base directory for files which match at least one include
pattern and don't match any exclude patterns. If there are selectors
then the files must pass muster there, as well.
- scan in interface FileScanner
scandir
protected void scandir(File dir,
String vpath,
boolean fast)
Scan the given directory for files and directories. Found files and
directories are placed in their respective collections, based on the
matching of includes, excludes, and the selectors. When a directory
is found, it is scanned recursively.
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.
setBasedir
public void setBasedir(File basedir)
Set the base directory to be scanned. This is the directory which is
scanned recursively.
- setBasedir in interface FileScanner
basedir
- The base directory for scanning.
Should not be null
.
setBasedir
public void setBasedir(String basedir)
Set the base directory to be scanned. This is the directory which is
scanned recursively. All '/' and '\' characters are replaced by
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
.
setCaseSensitive
public void setCaseSensitive(boolean isCaseSensitive)
Set whether or not include and exclude patterns are matched
in a case sensitive way.
- setCaseSensitive in interface FileScanner
isCaseSensitive
- whether or not the file system should be
regarded as a case sensitive one.
setExcludes
public void setExcludes(String[] excludes)
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.
- 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
.
setFollowSymlinks
public void setFollowSymlinks(boolean followSymlinks)
Set whether or not symbolic links should be followed.
followSymlinks
- whether or not symbolic links should be followed.
setIncludes
public void setIncludes(String[] includes)
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.
- 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
.
setSelectors
public void setSelectors(FileSelector[] selectors)
Set the selectors that will select the filelist.
- setSelectors in interface SelectorScanner
selectors
- specifies the selectors to be invoked on a scan.
slowScan
protected void slowScan()
Top level invocation for a slow scan. A slow scan builds up a full
list of excluded/included files/directories, whereas a fast scan
will only have full results for included files, as it ignores
directories which can't possibly hold any included files/directories.
Returns immediately if a slow scan has already been completed.