public class DirectoryScanner extends AbstractScanner
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: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: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 java.util.Vector<java.lang.String> |
dirsDeselected
The directories which matched at least one include and no excludes but which a selector discarded.
|
protected java.util.Vector<java.lang.String> |
dirsExcluded
The directories which matched at least one include and at least one exclude.
|
protected java.util.Vector<java.lang.String> |
dirsIncluded
The directories which matched at least one include and no excludes and were selected.
|
protected java.util.Vector<java.lang.String> |
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.util.Vector<java.lang.String> |
filesDeselected
The files which matched at least one include and no excludes and which a selector discarded.
|
protected java.util.Vector<java.lang.String> |
filesExcluded
The files which matched at least one include and at least one exclude.
|
protected java.util.Vector<java.lang.String> |
filesIncluded
The files which matched at least one include and no excludes and were selected.
|
protected java.util.Vector<java.lang.String> |
filesNotIncluded
The files which did not match any includes or selectors.
|
private boolean |
followSymlinks
Whether or not symbolic links should be followed.
|
protected boolean |
haveSlowResults
Whether or not our results were built by a slow scan.
|
private java.lang.String[] |
tokenizedEmpty |
DEFAULTEXCLUDES, excludes, includes, isCaseSensitive
Constructor and Description |
---|
DirectoryScanner()
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
java.io.File |
getBasedir()
Returns the base directory to be scanned.
|
java.lang.String[] |
getDeselectedDirectories()
Returns the names of the directories which were selected out and therefore not ultimately included.
|
java.lang.String[] |
getDeselectedFiles()
Returns the names of the files which were selected out and therefore not ultimately included.
|
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.
|
boolean |
isParentSymbolicLink(java.io.File parent,
java.lang.String name)
Checks whether the parent of this file is a symbolic link.
|
protected boolean |
isSelected(java.lang.String name,
java.io.File file)
Tests whether a name should be selected.
|
boolean |
isSymbolicLink(java.io.File parent,
java.lang.String name)
Checks whether a given file is a symbolic link.
|
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 |
setFollowSymlinks(boolean followSymlinks)
Sets whether or not symbolic links should be followed.
|
protected void |
slowScan()
Top level invocation for a slow scan.
|
addDefaultExcludes, couldHoldIncluded, isExcluded, isExcluded, isIncluded, isIncluded, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, setCaseSensitive, setExcludes, setIncludes, setupDefaultFilters, setupMatchPatterns
protected java.io.File basedir
protected java.util.Vector<java.lang.String> filesIncluded
protected java.util.Vector<java.lang.String> filesNotIncluded
protected java.util.Vector<java.lang.String> filesExcluded
protected java.util.Vector<java.lang.String> dirsIncluded
protected java.util.Vector<java.lang.String> dirsNotIncluded
protected java.util.Vector<java.lang.String> dirsExcluded
protected java.util.Vector<java.lang.String> filesDeselected
protected java.util.Vector<java.lang.String> dirsDeselected
protected boolean haveSlowResults
private boolean followSymlinks
protected boolean everythingIncluded
private final java.lang.String[] tokenizedEmpty
public void setBasedir(java.lang.String basedir)
File.separatorChar
, so the separator used need not match
File.separatorChar
.basedir
- The base directory to scan. Must not be null
.public void setBasedir(java.io.File basedir)
basedir
- The base directory for scanning. Should not be null
.public java.io.File getBasedir()
public void setFollowSymlinks(boolean followSymlinks)
followSymlinks
- whether or not symbolic links should be followedpublic boolean isEverythingIncluded()
true
if all files and directories which have been found so far have been included.public void scan() throws java.lang.IllegalStateException
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()
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 isSelected(java.lang.String name, java.io.File file)
name
- the filename to check for selectingfile
- the java.io.File object for this filenamefalse
when the selectors says that the file should not be selected, true
otherwise.public java.lang.String[] getIncludedFiles()
public java.lang.String[] getNotIncludedFiles()
slowScan()
public java.lang.String[] getExcludedFiles()
slowScan()
public java.lang.String[] getDeselectedFiles()
Returns 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.
slowScan()
public java.lang.String[] getIncludedDirectories()
public java.lang.String[] getNotIncludedDirectories()
slowScan()
public java.lang.String[] getExcludedDirectories()
slowScan()
public java.lang.String[] getDeselectedDirectories()
Returns 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.
slowScan()
public boolean isSymbolicLink(java.io.File parent, java.lang.String name) throws java.io.IOException
It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical - this may lead to false positives on some platforms.
parent
- the parent directory of the file to testname
- the name of the file to test.java.io.IOException
- .public boolean isParentSymbolicLink(java.io.File parent, java.lang.String name) throws java.io.IOException
For java versions prior to 7 It doesn't really test for symbolic links but whether the canonical and absolute paths of the file are identical - this may lead to false positives on some platforms.
parent
- the parent directory of the file to testname
- the name of the file to test.java.io.IOException
- .