|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface used to describe the actions required of any type of directory scanner.
Method Summary | |
void |
addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
java.io.File |
getBasedir()
Returns the base directory to be scanned. |
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. |
void |
scan()
Scans the base directory for files which match at least one include pattern and don't match any exclude patterns. |
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 |
setCaseSensitive(boolean isCaseSensitive)
Sets whether or not the file system should be regarded as case sensitive. |
void |
setExcludes(java.lang.String[] excludes)
Sets the list of exclude patterns to use. |
void |
setIncludes(java.lang.String[] includes)
Sets the list of include patterns to use. |
Method Detail |
public void addDefaultExcludes()
public java.io.File getBasedir()
public java.lang.String[] getExcludedDirectories()
public java.lang.String[] getExcludedFiles()
public java.lang.String[] getIncludedDirectories()
public java.lang.String[] getIncludedFiles()
public java.lang.String[] getNotIncludedDirectories()
public java.lang.String[] getNotIncludedFiles()
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).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 void setExcludes(java.lang.String[] excludes)
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 setIncludes(java.lang.String[] includes)
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 setCaseSensitive(boolean isCaseSensitive)
isCaseSensitive
- whether or not the file system should be
regarded as a case sensitive one
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |