|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.composition.model.impl.DirectoryScanner
TODO Write class description.
Field Summary | |
protected static String[] |
DEFAULTEXCLUDES
Deprecated. use the getDefaultExcludes method instead. |
protected Vector |
dirsDeselected
The directories which matched at least one include and no excludes but which a selector discarded. |
protected Vector |
dirsExcluded
The directories which matched at least one include and at least one exclude. |
protected Vector |
dirsIncluded
The directories which matched at least one include and no excludes and were selected. |
protected Vector |
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 String[] |
excludes
The patterns for the files to be excluded. |
protected Vector |
filesDeselected
The files which matched at least one include and no excludes and which a selector discarded. |
protected Vector |
filesExcluded
The files which matched at least one include and at least one exclude. |
protected Vector |
filesIncluded
The files which matched at least one include and no excludes and were selected. |
protected 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 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. |
protected FileSelector[] |
selectors
Selectors that will filter which files are in our candidate list. |
Constructor Summary | |
DirectoryScanner()
Sole constructor. |
Method Summary | |
static boolean |
addDefaultExclude(String s)
Add a pattern to the default excludes unless it is already a default exclude. |
protected boolean |
couldHoldIncluded(String name)
Tests whether or not a name matches the start of at least one include pattern. |
File |
getBasedir()
Returns the base directory to be scanned. |
static String[] |
getDefaultExcludes()
Get the list of patterns that should be excluded by default. |
String[] |
getIncludedFiles()
Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns. |
Logger |
getLogger()
|
boolean |
isCaseSensitive()
Find out whether include exclude patterns are matched in a case sensitive way |
boolean |
isEverythingIncluded()
Returns whether or not the scanner has included all the files or directories it has come across so far. |
protected boolean |
isExcluded(String name)
Tests whether or not a name matches against at least one exclude pattern. |
boolean |
isFollowSymlinks()
gets whether or not a DirectoryScanner follows symbolic links |
protected boolean |
isIncluded(String name)
Tests whether or not a name matches against at least one include pattern. |
protected boolean |
isSelected(String name,
File file)
Tests whether a name should be selected. |
static boolean |
match(String pattern,
String str)
Tests whether or not a string matches against a pattern. |
protected static boolean |
match(String pattern,
String str,
boolean isCaseSensitive)
Tests whether or not a string matches against a pattern. |
protected static boolean |
matchPath(String pattern,
String str)
Tests whether or not a given path matches a given pattern. |
protected static boolean |
matchPath(String pattern,
String str,
boolean isCaseSensitive)
Tests whether or not a given path matches a given pattern. |
protected static boolean |
matchPatternStart(String pattern,
String str)
Tests whether or not a given path matches the start of a given pattern up to the first "**". |
protected static boolean |
matchPatternStart(String pattern,
String str,
boolean isCaseSensitive)
Tests whether or not a given path matches the start of a given pattern up to the first "**". |
static boolean |
removeDefaultExclude(String s)
Remove a string if it is a default exclude. |
static void |
resetDefaultExcludes()
Go back to the hard wired default exclude patterns |
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(File dir,
String vpath,
boolean fast)
Scans the given directory for files and directories. |
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 include and exclude patterns are matched in a case sensitive way |
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 |
setLogger(Logger logger)
|
void |
setSelectors(FileSelector[] selectors)
Sets the selectors that will select the filelist. |
String |
toString()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected static final 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.
protected String[] includes
protected String[] excludes
protected FileSelector[] selectors
protected Vector filesIncluded
protected Vector filesNotIncluded
protected Vector filesExcluded
protected Vector dirsIncluded
protected Vector dirsNotIncluded
protected Vector dirsExcluded
protected Vector filesDeselected
protected Vector dirsDeselected
protected boolean haveSlowResults
protected boolean isCaseSensitive
protected boolean everythingIncluded
Constructor Detail |
public DirectoryScanner()
Method Detail |
protected static boolean matchPatternStart(String pattern, 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(String pattern, 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(String pattern, 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(String pattern, 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(String pattern, 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(String pattern, 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 String[] getDefaultExcludes()
String
based on the current
contents of the defaultExcludes
Vector
.public static boolean addDefaultExclude(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(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 withpublic static void resetDefaultExcludes()
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(File basedir)
basedir
- The base directory for scanning.
Should not be null
.public File getBasedir()
public boolean isCaseSensitive()
public void setCaseSensitive(boolean isCaseSensitive)
isCaseSensitive
- whether or not the file system should be
regarded as a case sensitive onepublic boolean isFollowSymlinks()
public 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 setSelectors(FileSelector[] selectors)
selectors
- specifies the selectors to be invoked on a scanpublic boolean isEverythingIncluded()
true
if all files and directories which have
been found so far have been included.public void scan() throws IllegalStateException, IOException
IllegalStateException
- if the base directory was set
incorrectly (i.e. if it is null
, doesn't exist,
or isn't a directory).
IOException
protected void scandir(File dir, String vpath, boolean fast) throws IOException
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.
IOException
filesIncluded
,
filesNotIncluded
,
filesExcluded
,
dirsIncluded
,
dirsNotIncluded
,
dirsExcluded
protected boolean isIncluded(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(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(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(String name, File file)
name
- the filename to check for selectingfile
- the java.io.File object for this filename
false
when the selectors says that the file
should not be selected, true
otherwise.public String[] getIncludedFiles()
public String toString()
public Logger getLogger()
public void setLogger(Logger logger)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |