java.lang.Object
- com.kazurayam.ant.DirectoryScanner

すべての実装されたインタフェース:

FileScanner
```
public class DirectoryScanner
extends java.lang.Object
implements FileScanner
```
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.separators 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 the above 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:
```
   import com.kazurayam.ant.DirectoryScanner;

   DirectoryScanner ds = new DirectoryScanner();
   ds.setBaseDir("build/classes")
   String[] includes = {"**\\*.class"};
   String[] excludes = {"**\\test\\**\\*"};
   ds.setIncludes(includes);
   ds.setExcludes(excludes);
   ds.scan();

   System.out.println("main classes:");
   String[] files = ds.getIncludedFiles();
   for (int i = 0; i < files.length; i++) {
     System.out.println(files[i]);
   }
 
```
This will scan a directory "./build/classes" for .class files, but excludes all files in subdirectories of a directory called "test".

フィールドの概要

フィールド
修飾子とタイプ	フィールド	説明
`protected java.io.File`	`basedir`	The base directory to be scanned.
`protected static java.lang.String[]`	`DEFAULTEXCLUDES`	推奨されていません。 since 1.6.x.
`protected java.util.Vector<java.lang.String>`	`dirsDeselected`	The directories which matched at least one include and no excludes but which a selector discarded.
`protected java.util.Vector<java.lang.String>`	`dirsExcluded`	The directories which matched at least one include and at least one exclude.
`protected java.util.Vector<java.lang.String>`	`dirsIncluded`	The directories which matched at least one include and no excludes and were selected.
`protected java.util.Vector<java.lang.String>`	`dirsNotIncluded`	The directories which were found and did not match any includes.
`static java.lang.String`	`DOES_NOT_EXIST_POSTFIX`	The end of the exception message if something that should be there doesn't exist.
`protected boolean`	`errorOnMissingDir`	Whether a missing base directory is an error.
`protected boolean`	`everythingIncluded`	Whether or not everything tested so far has been included.
`protected java.lang.String[]`	`excludes`	The patterns for the files to be excluded.
`protected java.util.Vector<java.lang.String>`	`filesDeselected`	The files which matched at least one include and no excludes and which a selector discarded.
`protected java.util.Vector<java.lang.String>`	`filesExcluded`	The files which matched at least one include and at least one exclude.
`protected java.util.Vector<java.lang.String>`	`filesIncluded`	The files which matched at least one include and no excludes and were selected.
`protected java.util.Vector<java.lang.String>`	`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 java.lang.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.
`static int`	`MAX_LEVELS_OF_SYMLINKS`	default value for `maxLevelsOfSymlinks`

コンストラクタの概要

コンストラクタ
コンストラクタ説明

DirectoryScanner()

メソッドの概要

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`void`	`addDefaultExcludes()`	Add default exclusions to the current exclusions set.
`protected void`	`clearResults()`	Clear the result caches for a scan.
`java.io.File`	`getBasedir()`	Return the base directory to be scanned.
`static java.lang.String[]`	`getDefaultExcludes()`	Get the list of patterns that should be excluded by default.
`java.lang.String[]`	`getExcludedDirectories()`	Return 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()`	Return 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()`	Return the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
`int`	`getIncludedDirsCount()`	Return the count of included directories.
`java.lang.String[]`	`getIncludedFiles()`	Return the names of the files which matched at least one of the include patterns and none of the exclude patterns.
`int`	`getIncludedFilesCount()`	Return the count of included files.
`java.lang.String[]`	`getNotFollowedSymlinks()`	Absolute paths of all symbolic links that haven't been followed but would have been followed had followsymlinks been true or maxLevelsOfSymlinks been bigger.
`java.lang.String[]`	`getNotIncludedDirectories()`	Return the names of the directories which matched none of the include patterns.
`java.lang.String[]`	`getNotIncludedFiles()`	Return the names of the files which matched none of the include patterns.
`boolean`	`isCaseSensitive()`	Find out whether include exclude patterns are matched in a case sensitive way.
`protected boolean`	`isSelected(java.lang.String name, java.io.File file)`	Test whether a file should be selected.
`protected static boolean`	`matchPatternStart(java.lang.String pattern, java.lang.String str)`	Test whether or not a given path matches the start of a given pattern up to the first "**".
`static void`	`resetDefaultExcludes()`	Go back to the hardwired default exclude patterns.
`void`	`scan()`	Scan for files which match at least one include pattern and don't match any exclude patterns.
`protected void`	`scandir(java.io.File dir, java.lang.String vpath, boolean fast)`	Scan the given directory for files and directories.
`void`	`setBasedir(java.io.File basedir)`	Set the base directory to be scanned.
`void`	`setBasedir(java.lang.String basedir)`	Set the base directory to be scanned.
`void`	`setCaseSensitive(boolean isCaseSensitive)`	Set whether or not include and exclude patterns are matched in a case sensitive way.
`void`	`setExcludes(java.lang.String[] excludes)`	Set the list of exclude patterns to use.
`void`	`setIncludes(java.lang.String[] includes)`	Set the list of include patterns to use.
`protected void`	`slowScan()`	Top level invocation for a slow scan.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - DEFAULTEXCLUDES
```
@Deprecated
protected static final java.lang.String[] DEFAULTEXCLUDES
```
    推奨されていません。
    since 1.6.x. Use the getDefaultExcludes method instead.
    
    Patterns which should be excluded by default.
    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.
  - MAX_LEVELS_OF_SYMLINKS
```
public static final int MAX_LEVELS_OF_SYMLINKS
```
    default value for maxLevelsOfSymlinks
    
    導入されたバージョン:
    
    Ant 1.8.0
    
    関連項目:
    
    定数フィールド値
  - DOES_NOT_EXIST_POSTFIX
```
public static final java.lang.String DOES_NOT_EXIST_POSTFIX
```
    The end of the exception message if something that should be there doesn't exist.
    
    関連項目:
    
    定数フィールド値
  - basedir
```
protected java.io.File basedir
```
    The base directory to be scanned.
  - includes
```
protected java.lang.String[] includes
```
    The patterns for the files to be included.
  - excludes
```
protected java.lang.String[] excludes
```
    The patterns for the files to be excluded.
  - filesIncluded
```
protected java.util.Vector<java.lang.String> filesIncluded
```
    The files which matched at least one include and no excludes and were selected.
  - filesNotIncluded
```
protected java.util.Vector<java.lang.String> filesNotIncluded
```
    The files which did not match any includes or selectors.
  - filesExcluded
```
protected java.util.Vector<java.lang.String> filesExcluded
```
    The files which matched at least one include and at least one exclude.
  - dirsIncluded
```
protected java.util.Vector<java.lang.String> dirsIncluded
```
    The directories which matched at least one include and no excludes and were selected.
  - dirsNotIncluded
```
protected java.util.Vector<java.lang.String> dirsNotIncluded
```
    The directories which were found and did not match any includes.
  - dirsExcluded
```
protected java.util.Vector<java.lang.String> dirsExcluded
```
    The directories which matched at least one include and at least one exclude.
  - filesDeselected
```
protected java.util.Vector<java.lang.String> filesDeselected
```
    The files which matched at least one include and no excludes and which a selector discarded.
  - dirsDeselected
```
protected java.util.Vector<java.lang.String> dirsDeselected
```
    The directories which matched at least one include and no excludes but which a selector discarded.
  - haveSlowResults
```
protected boolean haveSlowResults
```
    Whether or not our results were built by a slow scan.
  - isCaseSensitive
```
protected boolean isCaseSensitive
```
    Whether or not the file system should be treated as a case sensitive one.
  - errorOnMissingDir
```
protected boolean errorOnMissingDir
```
    Whether a missing base directory is an error.
    
    導入されたバージョン:
    
    Ant 1.7.1
  - everythingIncluded
```
protected boolean everythingIncluded
```
    Whether or not everything tested so far has been included.
- コンストラクタの詳細
  - DirectoryScanner
```
public DirectoryScanner()
```
- メソッドの詳細
  - matchPatternStart
```
protected static boolean matchPatternStart(java.lang.String pattern,
                                           java.lang.String str)
```
    Test whether or not a given path matches the start of a given pattern up to the first "**".
    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.
    
    戻り値:
    
    whether or not a given path matches the start of a given pattern up to the first "**".
  - getDefaultExcludes
```
public static java.lang.String[] getDefaultExcludes()
```
    Get the list of patterns that should be excluded by default.
    
    戻り値:
    
    An array of String based on the current contents of the defaultExcludes Set.
    
    導入されたバージョン:
    
    Ant 1.6
  - resetDefaultExcludes
```
public static void resetDefaultExcludes()
```
    Go back to the hardwired default exclude patterns.
    
    導入されたバージョン:
    
    Ant 1.6
  - setBasedir
```
public void setBasedir(java.lang.String basedir)
```
    Set the base directory to be scanned. This is the directory which is scanned recursively. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.
    
    定義:
    
    setBasedir インタフェース内 FileScanner
    
    パラメータ:
    
    basedir - The base directory to scan.
  - setBasedir
```
public void setBasedir(java.io.File basedir)
```
    Set the base directory to be scanned. This is the directory which is scanned recursively.
    
    定義:
    
    setBasedir インタフェース内 FileScanner
    
    パラメータ:
    
    basedir - The base directory for scanning.
  - getBasedir
```
public java.io.File getBasedir()
```
    Return the base directory to be scanned. This is the directory which is scanned recursively.
    
    定義:
    
    getBasedir インタフェース内 FileScanner
    
    戻り値:
    
    the base directory to be scanned.
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Find out whether include exclude patterns are matched in a case sensitive way.
    
    戻り値:
    
    whether or not the scanning is case sensitive.
    
    導入されたバージョン:
    
    Ant 1.6
  - setCaseSensitive
```
public void setCaseSensitive(boolean isCaseSensitive)
```
    Set whether or not include and exclude patterns are matched in a case sensitive way.
    
    定義:
    
    setCaseSensitive インタフェース内 FileScanner
    
    パラメータ:
    
    isCaseSensitive - whether or not the file system should be regarded as a case sensitive one.
  - setIncludes
```
public void setIncludes(java.lang.String[] includes)
```
    Set the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.
    When a pattern ends with a '/' or '\', "**" is appended.
    
    定義:
    
    setIncludes インタフェース内 FileScanner
    
    パラメータ:
    
    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.
  - setExcludes
```
public void setExcludes(java.lang.String[] excludes)
```
    Set the list of exclude patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.
    When a pattern ends with a '/' or '\', "**" is appended.
    
    定義:
    
    setExcludes インタフェース内 FileScanner
    
    パラメータ:
    
    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.
  - scan
```
public void scan()
          throws java.lang.IllegalStateException
```
    Scan 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. Scans under basedir, if set; otherwise the include patterns without leading wildcards specify the absolute paths of the files that may be included.
    
    定義:
    
    scan インタフェース内 FileScanner
    
    例外:
    
    java.lang.IllegalStateException - if the base directory was set incorrectly (i.e. if it doesn't exist or isn't a directory).
  - clearResults
```
protected void clearResults()
```
    Clear the result caches for a scan.
  - slowScan
```
protected void slowScan()
```
    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
```
protected void scandir(java.io.File dir,
                       java.lang.String vpath,
                       boolean fast)
```
    Scan 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.
    
    パラメータ:
    
    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.
    
    関連項目:
    
    filesIncluded, filesNotIncluded, filesExcluded, dirsIncluded, dirsNotIncluded, dirsExcluded, slowScan()
  - isSelected
```
protected boolean isSelected(java.lang.String name,
                             java.io.File file)
```
    Test whether a file should be selected.
    
    パラメータ:
    
    name - the filename to check for selecting.
    
    file - the java.io.File object for this filename.
    
    戻り値:
    
    false when the selectors says that the file should not be selected, true otherwise.
  - getIncludedFiles
```
public java.lang.String[] getIncludedFiles()
```
    Return 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.
    
    定義:
    
    getIncludedFiles インタフェース内 FileScanner
    
    戻り値:
    
    the names of the files which matched at least one of the include patterns and none of the exclude patterns.
  - getIncludedFilesCount
```
public int getIncludedFilesCount()
```
    Return the count of included files.
    
    戻り値:
    
    int.
    
    導入されたバージョン:
    
    Ant 1.6.3
  - getNotIncludedFiles
```
public java.lang.String[] getNotIncludedFiles()
```
    Return 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.
    
    定義:
    
    getNotIncludedFiles インタフェース内 FileScanner
    
    戻り値:
    
    the names of the files which matched none of the include patterns.
    
    関連項目:
    
    slowScan()
  - getExcludedFiles
```
public java.lang.String[] getExcludedFiles()
```
    Return 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.
    
    定義:
    
    getExcludedFiles インタフェース内 FileScanner
    
    戻り値:
    
    the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.
    
    関連項目:
    
    slowScan()
  - getIncludedDirectories
```
public java.lang.String[] getIncludedDirectories()
```
    Return 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.
    
    定義:
    
    getIncludedDirectories インタフェース内 FileScanner
    
    戻り値:
    
    the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
  - getIncludedDirsCount
```
public int getIncludedDirsCount()
```
    Return the count of included directories.
    
    戻り値:
    
    int.
    
    導入されたバージョン:
    
    Ant 1.6.3
  - getNotIncludedDirectories
```
public java.lang.String[] getNotIncludedDirectories()
```
    Return 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.
    
    定義:
    
    getNotIncludedDirectories インタフェース内 FileScanner
    
    戻り値:
    
    the names of the directories which matched none of the include patterns.
    
    関連項目:
    
    slowScan()
  - getExcludedDirectories
```
public java.lang.String[] getExcludedDirectories()
```
    Return 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.
    
    定義:
    
    getExcludedDirectories インタフェース内 FileScanner
    
    戻り値:
    
    the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.
    
    関連項目:
    
    slowScan()
  - getNotFollowedSymlinks
```
public java.lang.String[] getNotFollowedSymlinks()
```
    Absolute paths of all symbolic links that haven't been followed but would have been followed had followsymlinks been true or maxLevelsOfSymlinks been bigger.
    
    戻り値:
    
    sorted array of not followed symlinks
    
    導入されたバージョン:
    
    Ant 1.8.0
    
    関連項目:
    
    notFollowedSymlinks
  - addDefaultExcludes
```
public void addDefaultExcludes()
```
    Add default exclusions to the current exclusions set.
    
    定義:
    
    addDefaultExcludes インタフェース内 FileScanner

クラス DirectoryScanner

フィールドの概要

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

フィールドの詳細

DEFAULTEXCLUDES

MAX_LEVELS_OF_SYMLINKS

DOES_NOT_EXIST_POSTFIX

basedir

includes

excludes

filesIncluded

filesNotIncluded

filesExcluded

dirsIncluded

dirsNotIncluded

dirsExcluded

filesDeselected

dirsDeselected

haveSlowResults

isCaseSensitive

errorOnMissingDir

everythingIncluded

コンストラクタの詳細

DirectoryScanner

メソッドの詳細

matchPatternStart

getDefaultExcludes

resetDefaultExcludes

setBasedir

setBasedir

getBasedir

isCaseSensitive

setCaseSensitive

setIncludes

setExcludes

scan

clearResults

slowScan

scandir

isSelected

getIncludedFiles

getIncludedFilesCount

getNotIncludedFiles

getExcludedFiles

getIncludedDirectories

getIncludedDirsCount

getNotIncludedDirectories

getExcludedDirectories

getNotFollowedSymlinks

addDefaultExcludes