|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.maven.shared.utils.io.DirectoryScanner
public class DirectoryScanner
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 byFile.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" This class must not be used from multiple Threads concurrently!
Field Summary | |
---|---|
static String[] |
DEFAULTEXCLUDES
Patterns which should be excluded by default. |
Constructor Summary | |
---|---|
DirectoryScanner()
Sole constructor. |
Method Summary | |
---|---|
void |
addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
static DirectoryScanResult |
diffFiles(String[] oldFiles,
String[] newFiles)
|
DirectoryScanResult |
diffIncludedFiles(String... oldFiles)
Determine the file differences between the currently included files and a previously captured list of files. |
File |
getBasedir()
Returns the base directory to be scanned. |
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. |
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. |
String[] |
getIncludedDirectories()
Returns the names of the directories which matched at least one of the include patterns and none of the exclude patterns. |
String[] |
getIncludedFiles()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns. |
String[] |
getNotIncludedDirectories()
Returns the names of the directories which matched none of the include patterns. |
String[] |
getNotIncludedFiles()
Returns the names of the files which matched none of the include patterns. |
void |
scan()
Scans the base directory for files which match at least one include pattern and don't match any exclude patterns. |
void |
setBasedir(File basedir)
Sets the base directory to be scanned. |
void |
setBasedir(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(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(String... includes)
Sets the list of include patterns to use. |
void |
setScanConductor(ScanConductor scanConductor)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String[] DEFAULTEXCLUDES
addDefaultExcludes()
Constructor Detail |
---|
public DirectoryScanner()
Method Detail |
---|
public void setBasedir(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(@Nonnull File basedir)
basedir
- The base directory for scanning. Should not be null
.public File getBasedir()
public void setCaseSensitive(boolean isCaseSensitive)
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(String... includes)
File.separatorChar
, so the separator used need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
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(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
, indicating that no files should be
excluded. If a non-null
list is given, all elements must be non-null
.public void setScanConductor(ScanConductor scanConductor)
public void scan() throws IllegalStateException
IllegalStateException
- if the base directory was set incorrectly (i.e. if it is null
,
doesn't exist, or isn't a directory).public DirectoryScanResult diffIncludedFiles(String... oldFiles)
scan()
if no
result of a previous scan could be found.
The result of the diff can be queried by the methods
DirectoryScanResult.getFilesAdded()
and DirectoryScanResult.getFilesRemoved()
oldFiles
- the list of previously captured files names.public static DirectoryScanResult diffFiles(@Nullable String[] oldFiles, @Nullable String[] newFiles)
public String[] getIncludedFiles()
public String[] getNotIncludedFiles()
slowScan()
public String[] getExcludedFiles()
slowScan()
public String[] getIncludedDirectories()
public String[] getNotIncludedDirectories()
slowScan()
public String[] getExcludedDirectories()
slowScan()
public void addDefaultExcludes()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |