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 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"
This class must not be used from multiple Threads concurrently!
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate File
Deprecated.The base directory to be scanned.static final String[]
Deprecated.Patterns which should be excluded by default.Deprecated.The directories which matched at least one include and at least one exclude.Deprecated.The directories which matched at least one include and no excludes and were selected.Deprecated.The directories which were found and did not match any includes.private String[]
Deprecated.The patterns for the files to be excluded.private MatchPatterns
Deprecated.Deprecated.The files which matched at least one include and at least one exclude.Deprecated.The files which matched at least one include and no excludes and were selected.Deprecated.The files which did not match any includes or selectors.private boolean
Deprecated.Whether or not symbolic links should be followed.private boolean
Deprecated.Whether or not our results were built by a slow scan.private String[]
Deprecated.The patterns for the files to be included.private MatchPatterns
Deprecated.private boolean
Deprecated.Whether or not the file system should be treated as a case sensitive one.private ScanConductor.ScanAction
Deprecated.The last ScanAction.private ScanConductor
Deprecated.AScanConductor
an control the scanning process. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.Adds default exclusions to the current exclusions set.private static <T> Set<T>
arrayAsHashSet
(T[] array) Deprecated.Take an array of type T and convert it into a HashSet of type T.(package private) boolean
couldHoldIncluded
(String name) Deprecated.Tests whether or not a name matches the start of at least one include pattern.static DirectoryScanResult
Deprecated.diffIncludedFiles
(String... oldFiles) Deprecated.Determine the file differences between the currently included files and a previously captured list of files.private String[]
doNotFollowSymbolicLinks
(File dir, String vpath, String[] newfiles) Deprecated.Deprecated.Returns the base directory to be scanned.String[]
Deprecated.Returns the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.String[]
Deprecated.Returns the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.String[]
Deprecated.this method is buggy.String[]
Deprecated.this method does not work correctly on Windows.String[]
Deprecated.Returns the names of the directories which matched none of the include patterns.String[]
Deprecated.Returns the names of the files which matched none of the include patterns.(package private) boolean
isExcluded
(String name) Deprecated.Tests whether or not a name matches against at least one exclude pattern.(package private) boolean
isIncluded
(String name) Deprecated.Tests whether or not a name matches against at least one include pattern.(package private) boolean
isSymbolicLink
(File parent, String name) Deprecated.Checks whether a given file is a symbolic link.void
scan()
Deprecated.Scans the base directory for files which match at least one include pattern and don't match any exclude patterns.(package private) void
Deprecated.Scans the given directory for files and directories.void
setBasedir
(File basedir) Deprecated.Sets the base directory to be scanned.void
setBasedir
(String basedir) Deprecated.Sets the base directory to be scanned.void
setCaseSensitive
(boolean isCaseSensitiveParameter) Deprecated.Sets whether or not the file system should be regarded as case sensitive.void
setExcludes
(String... excludes) Deprecated.Sets the list of exclude patterns to use.void
setFollowSymlinks
(boolean followSymlinks) Deprecated.Sets whether or not symbolic links should be followed.void
setIncludes
(String... includes) Deprecated.Sets the list of include patterns to use.void
setScanConductor
(ScanConductor scanConductor) Deprecated.private void
Deprecated.private void
Deprecated.(package private) void
slowScan()
Deprecated.Top level invocation for a slow scan.
-
Field Details
-
DEFAULTEXCLUDES
Deprecated.Patterns which should be excluded by default.- See Also:
-
basedir
Deprecated.The base directory to be scanned. -
includes
Deprecated.The patterns for the files to be included. -
excludes
Deprecated.The patterns for the files to be excluded. -
excludesPatterns
Deprecated. -
includesPatterns
Deprecated. -
filesIncluded
Deprecated.The files which matched at least one include and no excludes and were selected. -
filesNotIncluded
Deprecated.The files which did not match any includes or selectors. -
filesExcluded
Deprecated.The files which matched at least one include and at least one exclude. -
dirsIncluded
Deprecated.The directories which matched at least one include and no excludes and were selected. -
dirsNotIncluded
Deprecated.The directories which were found and did not match any includes. -
dirsExcluded
Deprecated.The directories which matched at least one include and at least one exclude. -
haveSlowResults
private boolean haveSlowResultsDeprecated.Whether or not our results were built by a slow scan. -
isCaseSensitive
private boolean isCaseSensitiveDeprecated.Whether or not the file system should be treated as a case sensitive one. -
followSymlinks
private boolean followSymlinksDeprecated.Whether or not symbolic links should be followed. -
scanConductor
Deprecated.AScanConductor
an control the scanning process. -
scanAction
Deprecated.The last ScanAction. We need to store this in the instance as the scan() method doesn't return
-
-
Constructor Details
-
DirectoryScanner
public DirectoryScanner()Deprecated.Sole constructor.
-
-
Method Details
-
setBasedir
Deprecated.Sets the base directory to be scanned. This is the directory which is scanned recursively. All '/' and '\' characters are replaced byFile.separatorChar
, so the separator used need not matchFile.separatorChar
.- Parameters:
basedir
- The base directory to scan. Must not benull
.
-
setBasedir
Deprecated.Sets the base directory to be scanned. This is the directory which is scanned recursively.- Parameters:
basedir
- The base directory for scanning. Should not benull
.
-
getBasedir
Deprecated.Returns the base directory to be scanned. This is the directory which is scanned recursively.- Returns:
- the base directory to be scanned
-
setCaseSensitive
public void setCaseSensitive(boolean isCaseSensitiveParameter) Deprecated.Sets whether or not the file system should be regarded as case sensitive.- Parameters:
isCaseSensitiveParameter
- whether or not the file system should be regarded as a case sensitive one
-
setFollowSymlinks
public void setFollowSymlinks(boolean followSymlinks) Deprecated.Sets whether or not symbolic links should be followed.- Parameters:
followSymlinks
- whether or not symbolic links should be followed
-
setIncludes
Deprecated.Sets the list of include patterns to use. All '/' and '\' characters are replaced byFile.separatorChar
, so the separator used need not matchFile.separatorChar
.When a pattern ends with a '/' or '\', "**" is appended.
- Parameters:
includes
- A list of include patterns. May benull
, indicating that all files should be included. If a non-null
list is given, all elements must be non-null
.
-
setExcludes
Deprecated.Sets the list of exclude patterns to use. All '/' and '\' characters are replaced byFile.separatorChar
, so the separator used need not matchFile.separatorChar
.When a pattern ends with a '/' or '\', "**" is appended.
- Parameters:
excludes
- A list of exclude patterns. May benull
, indicating that no files should be excluded. If a non-null
list is given, all elements must be non-null
.
-
scan
Deprecated.Scans 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.- Throws:
IllegalStateException
- if the base directory was set incorrectly (i.e. if it isnull
, doesn't exist, or isn't a directory).
-
diffIncludedFiles
Deprecated.Determine the file differences between the currently included files and a previously captured list of files. This method will not look for a changed in content but sole in the list of files given.The method will compare the given array of file Strings with the result of the last directory scan. It will execute a
scan()
if no result of a previous scan could be found.The result of the diff can be queried by the methods
DirectoryScanResult.getFilesAdded()
andDirectoryScanResult.getFilesRemoved()
- Parameters:
oldFiles
- the list of previously captured files names.- Returns:
- the result of the directory scan.
-
diffFiles
public static DirectoryScanResult diffFiles(@Nullable String[] oldFiles, @Nullable String[] newFiles) Deprecated.- Parameters:
oldFiles
- array of old filesnewFiles
- array of new files- Returns:
- calculated difference
-
arrayAsHashSet
Deprecated.Take an array of type T and convert it into a HashSet of type T. Ifnull
or an empty array gets passed, an empty Set will be returned.- Parameters:
array
- The array- Returns:
- the filled HashSet of type T
-
slowScan
void slowScan()Deprecated.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. -
scandir
Deprecated.Scans 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.- Parameters:
dir
- The directory to scan. Must not benull
.vpath
- The path relative to the base directory (needed to prevent problems with an absolute path when using dir). Must not benull
.fast
- Whether or not this call is part of a fast scan.- See Also:
-
doNotFollowSymbolicLinks
Deprecated. -
isIncluded
Deprecated.Tests whether or not a name matches against at least one include pattern.- Parameters:
name
- The name to match. Must not benull
.- Returns:
true
when the name matches against at least one include pattern, orfalse
otherwise.
-
couldHoldIncluded
Deprecated.Tests whether or not a name matches the start of at least one include pattern.- Parameters:
name
- The name to match. Must not benull
.- Returns:
true
when the name matches against the start of at least one include pattern, orfalse
otherwise.
-
isExcluded
Deprecated.Tests whether or not a name matches against at least one exclude pattern.- Parameters:
name
- The name to match. Must not benull
.- Returns:
true
when the name matches against at least one exclude pattern, orfalse
otherwise.
-
getIncludedFiles
Deprecated.this method does not work correctly on Windows.Returns 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.- Returns:
- the names of the files which matched at least one of the include patterns and none of the exclude patterns. May also contain symbolic links to files.
-
getNotIncludedFiles
Deprecated.Returns 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.- Returns:
- the names of the files which matched none of the include patterns.
- See Also:
-
getExcludedFiles
Deprecated.Returns 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.- Returns:
- the names of the files which matched at least one of the include patterns and at at least one of the exclude patterns.
- See Also:
-
getIncludedDirectories
Deprecated.this method is buggy. Do not depend on it.Returns 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.- Returns:
- the names of the directories which matched at least one of the include patterns and none of the exclude patterns. May also contain symbolic links to directories.
-
getNotIncludedDirectories
Deprecated.Returns 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.- Returns:
- the names of the directories which matched none of the include patterns.
- See Also:
-
getExcludedDirectories
Deprecated.Returns 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.- Returns:
- the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.
- See Also:
-
addDefaultExcludes
public void addDefaultExcludes()Deprecated.Adds default exclusions to the current exclusions set. -
isSymbolicLink
Deprecated.Checks whether a given file is a symbolic link.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.
- Parameters:
parent
- the parent directory of the file to testname
- the name of the file to test.- Throws:
IOException
-
setupDefaultFilters
private void setupDefaultFilters()Deprecated. -
setupMatchPatterns
private void setupMatchPatterns()Deprecated.
-
java.nio.file.DirectoryStream
and related classes