org.apache.tools.ant
public interface FileScanner
Method Summary | |
---|---|
void | addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
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(String basedir)
Sets the base directory to be scanned. |
void | setBasedir(File 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 | setIncludes(String[] includes)
Sets the list of include patterns to use.
|
Returns: the base directory to be scanned
Returns: the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.
Returns: the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.
Returns: the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
Returns: the names of the files which matched at least one of the include patterns and none of the exclude patterns.
Returns: the names of the directories which matched none of the include patterns.
Returns: the names of the files which matched none of the include patterns.
Throws: IllegalStateException if the base directory was set
incorrectly (i.e. if it is null
, doesn't exist,
or isn't a directory).
File.separatorChar
, so the separator used need not match
File.separatorChar
.
Parameters: basedir The base directory to scan.
Must not be null
.
Parameters: basedir The base directory for scanning.
Should not be null
.
Parameters: isCaseSensitive whether or not the file system should be regarded as a case sensitive one
Parameters: 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
.
Parameters: 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
.