org.apache.avalon.composition.model.impl
Class DirectoryScanner

java.lang.Object
  extended byorg.apache.avalon.composition.model.impl.DirectoryScanner

public class DirectoryScanner
extends Object

TODO Write class description.

Version:
$Revision: 1.7 $ $Date: 2004/05/09 23:51:08 $
Author:
Apache Ant Development Team (Kuiper, Umasankar, Atherton, and Levy-Lambert), Avalon Development Team

Field Summary
protected static String[] DEFAULTEXCLUDES
          Deprecated. use the getDefaultExcludes method instead.
protected  Vector dirsDeselected
          The directories which matched at least one include and no excludes but which a selector discarded.
protected  Vector dirsExcluded
          The directories 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  boolean everythingIncluded
          Whether or not everything tested so far has been included.
protected  String[] excludes
          The patterns for the files to be excluded.
protected  Vector filesDeselected
          The files which matched at least one include and no excludes and which a selector discarded.
protected  Vector filesExcluded
          The files which matched at least one include and at least one exclude.
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  boolean haveSlowResults
          Whether or not our results were built by a slow scan.
protected  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.
protected  FileSelector[] selectors
          Selectors that will filter which files are in our candidate list.
 
Constructor Summary
DirectoryScanner()
          Sole constructor.
 
Method Summary
static boolean addDefaultExclude(String s)
          Add a pattern to the default excludes unless it is already a default exclude.
protected  boolean couldHoldIncluded(String name)
          Tests whether or not a name matches the start of at least one include pattern.
 File getBasedir()
          Returns the base directory to be scanned.
static String[] getDefaultExcludes()
          Get the list of patterns that should be excluded by default.
 String[] getIncludedFiles()
          Returns the names of the files which matched at least one of the include patterns and none of the exclude patterns.
 Logger getLogger()
           
 boolean isCaseSensitive()
          Find out whether include exclude patterns are matched in a case sensitive way
 boolean isEverythingIncluded()
          Returns whether or not the scanner has included all the files or directories it has come across so far.
protected  boolean isExcluded(String name)
          Tests whether or not a name matches against at least one exclude pattern.
 boolean isFollowSymlinks()
          gets whether or not a DirectoryScanner follows symbolic links
protected  boolean isIncluded(String name)
          Tests whether or not a name matches against at least one include pattern.
protected  boolean isSelected(String name, File file)
          Tests whether a name should be selected.
static boolean match(String pattern, String str)
          Tests whether or not a string matches against a pattern.
protected static boolean match(String pattern, String str, boolean isCaseSensitive)
          Tests whether or not a string matches against a pattern.
protected static boolean matchPath(String pattern, String str)
          Tests whether or not a given path matches a given pattern.
protected static boolean matchPath(String pattern, String str, boolean isCaseSensitive)
          Tests whether or not a given path matches a given pattern.
protected static boolean matchPatternStart(String pattern, String str)
          Tests whether or not a given path matches the start of a given pattern up to the first "**".
protected static boolean matchPatternStart(String pattern, String str, boolean isCaseSensitive)
          Tests whether or not a given path matches the start of a given pattern up to the first "**".
static boolean removeDefaultExclude(String s)
          Remove a string if it is a default exclude.
static void resetDefaultExcludes()
          Go back to the hard wired default exclude patterns
 void scan()
          Scans the base directory for files which match at least one include pattern and don't match any exclude patterns.
protected  void scandir(File dir, String vpath, boolean fast)
          Scans the given directory for files and directories.
 void setBasedir(File basedir)
          Sets the base directory to be scanned.
 void setBasedir(String basedir)
          Sets the base directory to be scanned.
 void setCaseSensitive(boolean isCaseSensitive)
          Sets whether or not include and exclude patterns are matched in a case sensitive way
 void setExcludes(String[] excludes)
          Sets the list of exclude patterns to use.
 void setFollowSymlinks(boolean followSymlinks)
          Sets whether or not symbolic links should be followed.
 void setIncludes(String[] includes)
          Sets the list of include patterns to use.
 void setLogger(Logger logger)
           
 void setSelectors(FileSelector[] selectors)
          Sets the selectors that will select the filelist.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULTEXCLUDES

protected static final String[] DEFAULTEXCLUDES
Deprecated. 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.


includes

protected String[] includes
The patterns for the files to be included.


excludes

protected String[] excludes
The patterns for the files to be excluded.


selectors

protected FileSelector[] selectors
Selectors that will filter which files are in our candidate list.


filesIncluded

protected Vector filesIncluded
The files which matched at least one include and no excludes and were selected.


filesNotIncluded

protected Vector filesNotIncluded
The files which did not match any includes or selectors.


filesExcluded

protected Vector filesExcluded
The files which matched at least one include and at least one exclude.


dirsIncluded

protected Vector dirsIncluded
The directories which matched at least one include and no excludes and were selected.


dirsNotIncluded

protected Vector dirsNotIncluded
The directories which were found and did not match any includes.


dirsExcluded

protected Vector dirsExcluded
The directories which matched at least one include and at least one exclude.


filesDeselected

protected Vector filesDeselected
The files which matched at least one include and no excludes and which a selector discarded.


dirsDeselected

protected Vector 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.


everythingIncluded

protected boolean everythingIncluded
Whether or not everything tested so far has been included.

Constructor Detail

DirectoryScanner

public DirectoryScanner()
Sole constructor.

Method Detail

matchPatternStart

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

Parameters:
pattern - The pattern to match against. Must not be null.
str - The path to match, as a String. Must not be null.
Returns:
whether or not a given path matches the start of a given pattern up to the first "**".

matchPatternStart

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

Parameters:
pattern - The pattern to match against. Must not be null.
str - The path to match, as a String. Must not be null.
isCaseSensitive - Whether or not matching should be performed case sensitively.
Returns:
whether or not a given path matches the start of a given pattern up to the first "**".

matchPath

protected static boolean matchPath(String pattern,
                                   String str)
Tests whether or not a given path matches a given pattern.

Parameters:
pattern - The pattern to match against. Must not be null.
str - The path to match, as a String. Must not be null.
Returns:
true if the pattern matches against the string, or false otherwise.

matchPath

protected static boolean matchPath(String pattern,
                                   String str,
                                   boolean isCaseSensitive)
Tests whether or not a given path matches a given pattern.

Parameters:
pattern - The pattern to match against. Must not be null.
str - The path to match, as a String. Must not be null.
isCaseSensitive - Whether or not matching should be performed case sensitively.
Returns:
true if the pattern matches against the string, or false otherwise.

match

public static boolean match(String pattern,
                            String str)
Tests 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

Parameters:
pattern - The pattern to match against. Must not be null.
str - The string which must be matched against the pattern. Must not be null.
Returns:
true if the string matches against the pattern, or false otherwise.

match

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

Parameters:
pattern - The pattern to match against. Must not be null.
str - The string which must be matched against the pattern. Must not be null.
isCaseSensitive - Whether or not matching should be performed case sensitively.
Returns:
true if the string matches against the pattern, or false otherwise.

getDefaultExcludes

public static String[] getDefaultExcludes()
Get the list of patterns that should be excluded by default.

Returns:
An array of String based on the current contents of the defaultExcludes Vector.

addDefaultExclude

public static boolean addDefaultExclude(String s)
Add a pattern to the default excludes unless it is already a default exclude.

Parameters:
s - A string to add as an exclude pattern.
Returns:
true if the string was added false if it already existed.

removeDefaultExclude

public static boolean removeDefaultExclude(String s)
Remove a string if it is a default exclude.

Parameters:
s - The string to attempt to remove.
Returns:
true if s was a default exclude (and thus was removed), false if s was not in the default excludes list to begin with

resetDefaultExcludes

public static void resetDefaultExcludes()
Go back to the hard wired default exclude patterns


setBasedir

public void setBasedir(String basedir)
Sets 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.

Parameters:
basedir - The base directory to scan. Must not be null.

setBasedir

public void setBasedir(File basedir)
Sets the base directory to be scanned. This is the directory which is scanned recursively.

Parameters:
basedir - The base directory for scanning. Should not be null.

getBasedir

public File getBasedir()
Returns the base directory to be scanned. This is the directory which is scanned recursively.

Returns:
the base directory to be scanned

isCaseSensitive

public boolean isCaseSensitive()
Find out whether include exclude patterns are matched in a case sensitive way

Returns:
whether or not the scanning is case sensitive
Since:
ant 1.6

setCaseSensitive

public void setCaseSensitive(boolean isCaseSensitive)
Sets whether or not include and exclude patterns are matched in a case sensitive way

Parameters:
isCaseSensitive - whether or not the file system should be regarded as a case sensitive one

isFollowSymlinks

public boolean isFollowSymlinks()
gets whether or not a DirectoryScanner follows symbolic links

Returns:
flag indicating whether symbolic links should be followed
Since:
ant 1.6

setFollowSymlinks

public void setFollowSymlinks(boolean followSymlinks)
Sets whether or not symbolic links should be followed.

Parameters:
followSymlinks - whether or not symbolic links should be followed

setIncludes

public void setIncludes(String[] includes)
Sets 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.

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.

setExcludes

public void setExcludes(String[] excludes)
Sets 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.

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.

setSelectors

public void setSelectors(FileSelector[] selectors)
Sets the selectors that will select the filelist.

Parameters:
selectors - specifies the selectors to be invoked on a scan

isEverythingIncluded

public boolean isEverythingIncluded()
Returns whether or not the scanner has included all the files or directories it has come across so far.

Returns:
true if all files and directories which have been found so far have been included.

scan

public void scan()
          throws IllegalStateException,
                 IOException
Scans the base directory 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.

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

scandir

protected void scandir(File dir,
                       String vpath,
                       boolean fast)
                throws IOException
Scans 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.

Parameters:
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.
Throws:
IOException
See Also:
filesIncluded, filesNotIncluded, filesExcluded, dirsIncluded, dirsNotIncluded, dirsExcluded

isIncluded

protected boolean isIncluded(String name)
Tests whether or not a name matches against at least one include pattern.

Parameters:
name - The name to match. Must not be null.
Returns:
true when the name matches against at least one include pattern, or false otherwise.

couldHoldIncluded

protected boolean couldHoldIncluded(String name)
Tests whether or not a name matches the start of at least one include pattern.

Parameters:
name - The name to match. Must not be null.
Returns:
true when the name matches against the start of at least one include pattern, or false otherwise.

isExcluded

protected boolean isExcluded(String name)
Tests whether or not a name matches against at least one exclude pattern.

Parameters:
name - The name to match. Must not be null.
Returns:
true when the name matches against at least one exclude pattern, or false otherwise.

isSelected

protected boolean isSelected(String name,
                             File file)
Tests whether a name should be selected.

Parameters:
name - the filename to check for selecting
file - the java.io.File object for this filename
Returns:
false when the selectors says that the file should not be selected, true otherwise.

getIncludedFiles

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

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

toString

public String toString()

getLogger

public Logger getLogger()

setLogger

public void setLogger(Logger logger)


Copyright © The Apache Software Foundation. All Rights Reserved.