FileDocCategorySizeDatePackage
FileScanner.javaAPI DocApache Ant 1.705660Wed Dec 13 06:16:18 GMT 2006org.apache.tools.ant

FileScanner

public interface FileScanner
An interface used to describe the actions required of any type of directory scanner.

Fields Summary
Constructors Summary
Methods Summary
public voidaddDefaultExcludes()
Adds default exclusions to the current exclusions set.

public java.io.FilegetBasedir()
Returns the base directory to be scanned. This is the directory which is scanned recursively.

return
the base directory to be scanned

public 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. The names are relative to the base directory.

return
the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.

public 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. The names are relative to the base directory.

return
the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.

public 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. The names are relative to the base directory.

return
the names of the directories which matched at least one of the include patterns and none of the exclude patterns.

public 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. The names are relative to the base directory.

return
the names of the files which matched at least one of the include patterns and none of the exclude patterns.

public java.lang.String[]getNotIncludedDirectories()
Returns the names of the directories which matched none of the include patterns. The names are relative to the base directory.

return
the names of the directories which matched none of the include patterns.

public java.lang.String[]getNotIncludedFiles()
Returns the names of the files which matched none of the include patterns. The names are relative to the base directory.

return
the names of the files which matched none of the include patterns.

public voidscan()
Scans the base directory for files which match at least one include pattern and don't match any exclude patterns.

exception
IllegalStateException if the base directory was set incorrectly (i.e. if it is null, doesn't exist, or isn't a directory).

public voidsetBasedir(java.lang.String basedir)
Sets the base directory to be scanned. This is the directory which is scanned recursively. All '/' and '\' characters should be replaced by File.separatorChar, so the separator used need not match File.separatorChar.

param
basedir The base directory to scan. Must not be null.

public voidsetBasedir(java.io.File basedir)
Sets the base directory to be scanned. This is the directory which is scanned recursively.

param
basedir The base directory for scanning. Should not be null.

public voidsetCaseSensitive(boolean isCaseSensitive)
Sets whether or not the file system should be regarded as case sensitive.

param
isCaseSensitive whether or not the file system should be regarded as a case sensitive one

public voidsetExcludes(java.lang.String[] excludes)
Sets the list of exclude patterns to use.

param
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 voidsetIncludes(java.lang.String[] includes)
Sets the list of include patterns to use.

param
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.