public class DirectoryScanner extends java.lang.Object implements FileScanner, SelectorScanner, ResourceFactory
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 < files.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"
Modifier and Type | Field and Description |
---|---|
protected java.io.File |
basedir
The base directory to be scanned.
|
protected static java.lang.String[] |
DEFAULTEXCLUDES
Deprecated.
since 1.6.x.
Use the
getDefaultExcludes
method instead. |
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.
|
static java.lang.String |
DOES_NOT_EXIST_POSTFIX
The end of the exception message if something that should be
there doesn't exist.
|
protected boolean |
errorOnMissingDir
Whether a missing base directory is an error.
|
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.
|
static int |
MAX_LEVELS_OF_SYMLINKS
default value for
maxLevelsOfSymlinks |
protected FileSelector[] |
selectors
Selectors that will filter which files are in our candidate list.
|
Constructor and Description |
---|
DirectoryScanner()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
addDefaultExclude(java.lang.String s)
Add a pattern to the default excludes unless it is already a
default exclude.
|
void |
addDefaultExcludes()
Add default exclusions to the current exclusions set.
|
void |
addExcludes(java.lang.String[] excludes)
Add to the list of exclude patterns to use.
|
protected void |
clearResults()
Clear the result caches for a scan.
|
protected boolean |
couldHoldIncluded(java.lang.String name)
Test whether or not a name matches the start of at least one include
pattern.
|
java.io.File |
getBasedir()
Return the base directory to be scanned.
|
static java.lang.String[] |
getDefaultExcludes()
Get the list of patterns that should be excluded by default.
|
java.lang.String[] |
getDeselectedDirectories()
Return the names of the directories which were selected out and
therefore not ultimately included.
|
java.lang.String[] |
getDeselectedFiles()
Return the names of the files which were selected out and
therefore not ultimately included.
|
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.
|
int |
getIncludedDirsCount()
Return the count of included directories.
|
java.lang.String[] |
getIncludedFiles()
Return the names of the files which matched at least one of the
include patterns and none of the exclude patterns.
|
int |
getIncludedFilesCount()
Return the count of included files.
|
java.lang.String[] |
getNotFollowedSymlinks()
Absolute paths of all symbolic links that haven't been followed
but would have been followed had followsymlinks been true or
maxLevelsOfSymlinks been bigger.
|
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.
|
Resource |
getResource(java.lang.String name)
Get the named resource.
|
boolean |
isCaseSensitive()
Find out whether include exclude patterns are matched in a
case sensitive way.
|
boolean |
isEverythingIncluded()
Return 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)
Test whether or not a name matches against at least one exclude
pattern.
|
boolean |
isFollowSymlinks()
Get whether or not a DirectoryScanner follows symbolic links.
|
protected boolean |
isIncluded(java.lang.String name)
Test whether or not a name matches against at least one include
pattern.
|
protected boolean |
isSelected(java.lang.String name,
java.io.File file)
Test whether a file should be selected.
|
static boolean |
match(java.lang.String pattern,
java.lang.String str)
Test whether or not a string matches against a pattern.
|
protected static boolean |
match(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)
Test whether or not a string matches against a pattern.
|
protected static boolean |
matchPath(java.lang.String pattern,
java.lang.String str)
Test whether or not a given path matches a given pattern.
|
protected static boolean |
matchPath(java.lang.String pattern,
java.lang.String str,
boolean isCaseSensitive)
Test whether or not a given path matches a given pattern.
|
protected static boolean |
matchPatternStart(java.lang.String pattern,
java.lang.String str)
Test 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)
Test whether or not a given path matches the start of a given
pattern up to the first "**".
|
static boolean |
removeDefaultExclude(java.lang.String s)
Remove a string if it is a default exclude.
|
static void |
resetDefaultExcludes()
Go back to the hardwired default exclude patterns.
|
void |
scan()
Scan 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)
Scan the given directory for files and directories.
|
void |
setBasedir(java.io.File basedir)
Set the base directory to be scanned.
|
void |
setBasedir(java.lang.String basedir)
Set the base directory to be scanned.
|
void |
setCaseSensitive(boolean isCaseSensitive)
Set whether or not include and exclude patterns are matched
in a case sensitive way.
|
void |
setErrorOnMissingDir(boolean errorOnMissingDir)
Sets whether or not a missing base directory is an error
|
void |
setExcludes(java.lang.String[] excludes)
Set the list of exclude patterns to use.
|
void |
setFollowSymlinks(boolean followSymlinks)
Set whether or not symbolic links should be followed.
|
void |
setIncludes(java.lang.String[] includes)
Set the list of include patterns to use.
|
void |
setMaxLevelsOfSymlinks(int max)
The maximum number of times a symbolic link may be followed
during a scan.
|
void |
setSelectors(FileSelector[] selectors)
Set the selectors that will select the filelist.
|
protected void |
slowScan()
Top level invocation for a slow scan.
|
protected static final java.lang.String[] DEFAULTEXCLUDES
getDefaultExcludes
method instead.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.
public static final int MAX_LEVELS_OF_SYMLINKS
maxLevelsOfSymlinks
public static final java.lang.String DOES_NOT_EXIST_POSTFIX
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 errorOnMissingDir
protected boolean everythingIncluded
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 static java.lang.String[] getDefaultExcludes()
String
based on the current
contents of the defaultExcludes
Set
.public static boolean addDefaultExclude(java.lang.String s)
s
- A string to add as an exclude pattern.true
if the string was added;
false
if it already existed.public static boolean removeDefaultExclude(java.lang.String s)
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.public static void resetDefaultExcludes()
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.public void setBasedir(java.io.File basedir)
setBasedir
in interface FileScanner
basedir
- The base directory for scanning.public java.io.File getBasedir()
getBasedir
in interface FileScanner
public boolean isCaseSensitive()
public void setCaseSensitive(boolean isCaseSensitive)
setCaseSensitive
in interface FileScanner
isCaseSensitive
- whether or not the file system should be
regarded as a case sensitive one.public void setErrorOnMissingDir(boolean errorOnMissingDir)
errorOnMissingDir
- whether or not a missing base directory
is an errorpublic boolean isFollowSymlinks()
public void setFollowSymlinks(boolean followSymlinks)
followSymlinks
- whether or not symbolic links should be followed.public void setMaxLevelsOfSymlinks(int max)
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
- 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 addExcludes(java.lang.String[] excludes)
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.public void setSelectors(FileSelector[] selectors)
setSelectors
in interface SelectorScanner
selectors
- specifies the selectors to be invoked on a scan.public 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 doesn't exist or isn't a directory).protected void clearResults()
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 selecting.file
- 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 int getIncludedFilesCount()
int
.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()
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
slowScan()
public java.lang.String[] getIncludedDirectories()
getIncludedDirectories
in interface FileScanner
public int getIncludedDirsCount()
int
.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()
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
slowScan()
public java.lang.String[] getNotFollowedSymlinks()
public void addDefaultExcludes()
addDefaultExcludes
in interface FileScanner
public Resource getResource(java.lang.String name)
getResource
in interface ResourceFactory
name
- path name of the file relative to the dir attribute.