Save This Page
Home » apache-ant-1.8.1 » org.apache.tools » ant » [javadoc | source]
org.apache.tools.ant
public class: DirectoryScanner [javadoc | source]
java.lang.Object
   org.apache.tools.ant.DirectoryScanner

All Implemented Interfaces:
    SelectorScanner, FileScanner, ResourceFactory

Direct Known Subclasses:
    ZipScanner, LocalDirectoryScanner, TarScanner, DependScanner, ArchiveScanner, VAJWorkspaceScanner, FTPDirectoryScanner, FTPDirectoryScanner

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 these 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:

  String[] includes = {"**\\*.class"};
  String[] excludes = {"modules\\*\\**"};
  ds.setIncludes(includes);
  ds.setExcludes(excludes);
  ds.setBasedir(new File("test"));
  ds.setCaseSensitive(true);
  ds.scan();

  System.out.println("FILES:");
  String[] files = ds.getIncludedFiles();
  for (int i = 0; i < files.length; i++) {
    System.out.println(files[i]);
  }
This will scan a directory called test for .class files, but excludes all files in all proper subdirectories of a directory called "modules"
Field Summary
protected static final  String[] DEFAULTEXCLUDES    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.

     
    public static final  int MAX_LEVELS_OF_SYMLINKS    default value for maxLevelsOfSymlinks
      since: Ant - 1.8.0
     
    public static final  String DOES_NOT_EXIST_POSTFIX    The end of the exception message if something that should be there doesn't exist. 
    protected  File basedir    The base directory to be scanned. 
    protected  String[] includes    The patterns for the files to be included. 
    protected  String[] excludes    The patterns for the files to be excluded. 
    protected  FileSelector[] selectors    Selectors that will filter which files are in our candidate list. 
    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  Vector filesExcluded    The files 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  Vector dirsExcluded    The directories which matched at least one include and at least one exclude. 
    protected  Vector filesDeselected    The files which matched at least one include and no excludes and which a selector discarded. 
    protected  Vector dirsDeselected    The directories which matched at least one include and no excludes but which a selector discarded. 
    protected  boolean haveSlowResults    Whether or not our results were built by a slow scan. 
    protected  boolean isCaseSensitive    Whether or not the file system should be treated as a case sensitive one. 
    protected  boolean errorOnMissingDir    Whether a missing base directory is an error.
      since: Ant - 1.7.1
     
    protected  boolean everythingIncluded    Whether or not everything tested so far has been included. 
    Constructor:
     public DirectoryScanner() 
    Method from org.apache.tools.ant.DirectoryScanner Summary:
    addDefaultExclude,   addDefaultExcludes,   addExcludes,   clearResults,   couldHoldIncluded,   getBasedir,   getDefaultExcludes,   getDeselectedDirectories,   getDeselectedFiles,   getExcludedDirectories,   getExcludedFiles,   getIncludedDirectories,   getIncludedDirsCount,   getIncludedFiles,   getIncludedFilesCount,   getNotFollowedSymlinks,   getNotIncludedDirectories,   getNotIncludedFiles,   getResource,   getScannedDirs,   isCaseSensitive,   isEverythingIncluded,   isExcluded,   isFollowSymlinks,   isIncluded,   isSelected,   match,   match,   matchPath,   matchPath,   matchPatternStart,   matchPatternStart,   removeDefaultExclude,   resetDefaultExcludes,   scan,   scandir,   setBasedir,   setBasedir,   setCaseSensitive,   setErrorOnMissingDir,   setExcludes,   setFollowSymlinks,   setIncludes,   setMaxLevelsOfSymlinks,   setSelectors,   slowScan
    Methods from java.lang.Object:
    clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
    Method from org.apache.tools.ant.DirectoryScanner Detail:
     public static boolean addDefaultExclude(String s) 
      Add a pattern to the default excludes unless it is already a default exclude.
     public synchronized  void addDefaultExcludes() 
      Add default exclusions to the current exclusions set.
     public synchronized  void addExcludes(String[] excludes) 
      Add to 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.

     protected synchronized  void clearResults() 
      Clear the result caches for a scan.
     protected boolean couldHoldIncluded(String name) 
      Test whether or not a name matches the start of at least one include pattern.
     public synchronized File getBasedir() 
      Return the base directory to be scanned. This is the directory which is scanned recursively.
     public static String[] getDefaultExcludes() 
      Get the list of patterns that should be excluded by default.
     public synchronized String[] getDeselectedDirectories() 

      Return the names of the directories which were selected out and therefore not ultimately included.

      The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.

     public synchronized String[] getDeselectedFiles() 

      Return the names of the files which were selected out and therefore not ultimately included.

      The names are relative to the base directory. This involves performing a slow scan if one has not already been completed.

     public synchronized 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.
     public synchronized 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.
     public 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.
     public synchronized int getIncludedDirsCount() 
      Return the count of included directories.
     public 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.
     public synchronized int getIncludedFilesCount() 
      Return the count of included files.
     public synchronized 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.
     public synchronized 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.
     public synchronized 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.
     public synchronized Resource getResource(String name) 
      Get the named resource.
     Set getScannedDirs() 
      This method is of interest for testing purposes. The returned Set is live and should not be modified.
     public synchronized boolean isCaseSensitive() 
      Find out whether include exclude patterns are matched in a case sensitive way.
     public synchronized boolean isEverythingIncluded() 
      Return whether or not the scanner has included all the files or directories it has come across so far.
     protected boolean isExcluded(String name) 
      Test whether or not a name matches against at least one exclude pattern.
     public synchronized boolean isFollowSymlinks() 
      Get whether or not a DirectoryScanner follows symbolic links.
     protected boolean isIncluded(String name) 
      Test whether or not a name matches against at least one include pattern.
     protected boolean isSelected(String name,
        File file) 
      Test whether a file should be selected.
     public static boolean match(String pattern,
        String str) 
      Test whether or not a string matches against a pattern. The pattern may contain two special characters:
      '*' means zero or more characters
      '?' means one and only one character
     protected static boolean match(String pattern,
        String str,
        boolean isCaseSensitive) 
      Test whether or not a string matches against a pattern. The pattern may contain two special characters:
      '*' means zero or more characters
      '?' means one and only one character
     protected static boolean matchPath(String pattern,
        String str) 
      Test whether or not a given path matches a given pattern.
     protected static boolean matchPath(String pattern,
        String str,
        boolean isCaseSensitive) 
      Test whether or not a given path matches a given pattern.
     protected static boolean matchPatternStart(String pattern,
        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.

     protected static boolean matchPatternStart(String pattern,
        String str,
        boolean isCaseSensitive) 
      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.

     public static boolean removeDefaultExclude(String s) 
      Remove a string if it is a default exclude.
     public static  void resetDefaultExcludes() 
      Go back to the hardwired default exclude patterns.
     public  void scan() throws 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.
     protected  void scandir(File dir,
        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.
     public  void setBasedir(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.
     public synchronized  void setBasedir(File basedir) 
      Set the base directory to be scanned. This is the directory which is scanned recursively.
     public synchronized  void setCaseSensitive(boolean isCaseSensitive) 
      Set whether or not include and exclude patterns are matched in a case sensitive way.
     public  void setErrorOnMissingDir(boolean errorOnMissingDir) 
      Sets whether or not a missing base directory is an error
     public synchronized  void setExcludes(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.

     public synchronized  void setFollowSymlinks(boolean followSymlinks) 
      Set whether or not symbolic links should be followed.
     public synchronized  void setIncludes(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.

     public  void setMaxLevelsOfSymlinks(int max) 
      The maximum number of times a symbolic link may be followed during a scan.
     public synchronized  void setSelectors(FileSelector[] selectors) 
      Set the selectors that will select the filelist.
     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.