org.apache.tools.ant.types.optional.depend

Class DependScanner

Implemented Interfaces:
FileScanner, ResourceFactory, SelectorScanner

public class DependScanner
extends DirectoryScanner

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

Field Summary

static String
DEFAULT_ANALYZER_CLASS
The name of the analyzer to use by default.

Fields inherited from class org.apache.tools.ant.DirectoryScanner

DEFAULTEXCLUDES, basedir, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, selectors

Constructor Summary

DependScanner(DirectoryScanner parentScanner)
Create a DependScanner, using the given scanner to provide the basic set of files from which class files come.

Method Summary

void
addDefaultExcludes()
File
getBasedir()
Gets the basedir that is used for scanning.
String[]
getExcludedDirectories()
String[]
getExcludedFiles()
String[]
getIncludedDirectories()
String[]
getIncludedFiles()
Get the names of the class files, baseClass depends on
String[]
getNotIncludedDirectories()
String[]
getNotIncludedFiles()
void
scan()
Scans the base directory for files that baseClass depends on
void
setBasedir(File basedir)
Sets the basedir for scanning.
void
setCaseSensitive(boolean isCaseSensitive)
void
setExcludes(String[] excludes)
void
setIncludes(String[] includes)
void
setRootClasses(Vector rootClasses)
Sets the root classes to be used to drive the scan.

Methods inherited from class org.apache.tools.ant.DirectoryScanner

addDefaultExclude, addDefaultExcludes, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getIncludedDirectories, getIncludedFiles, getNotIncludedDirectories, getNotIncludedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scan, scandir, setBasedir, setBasedir, setCaseSensitive, setExcludes, setFollowSymlinks, setIncludes, setSelectors, slowScan

Field Details

DEFAULT_ANALYZER_CLASS

public static final String DEFAULT_ANALYZER_CLASS
The name of the analyzer to use by default.

Constructor Details

DependScanner

public DependScanner(DirectoryScanner parentScanner)
Create a DependScanner, using the given scanner to provide the basic set of files from which class files come.

Parameters:
parentScanner - the DirectoryScanner which returns the files from which class files must come.

Method Details

addDefaultExcludes

public void addDefaultExcludes()
Specified by:
addDefaultExcludes in interface FileScanner
Overrides:
addDefaultExcludes in interface DirectoryScanner

See Also:
DirectoryScanner.addDefaultExcludes()


getBasedir

public File getBasedir()
Gets the basedir that is used for scanning.
Specified by:
getBasedir in interface FileScanner
Overrides:
getBasedir in interface DirectoryScanner

Returns:
the basedir that is used for scanning


getExcludedDirectories

public String[] getExcludedDirectories()
Specified by:
getExcludedDirectories in interface FileScanner
Overrides:
getExcludedDirectories in interface DirectoryScanner

See Also:
DirectoryScanner.getExcludedDirectories()


getExcludedFiles

public String[] getExcludedFiles()
Specified by:
getExcludedFiles in interface FileScanner
Overrides:
getExcludedFiles in interface DirectoryScanner

See Also:
DirectoryScanner.getExcludedFiles()


getIncludedDirectories

public String[] getIncludedDirectories()
Specified by:
getIncludedDirectories in interface FileScanner
Overrides:
getIncludedDirectories in interface DirectoryScanner

See Also:
DirectoryScanner.getIncludedDirectories()


getIncludedFiles

public String[] getIncludedFiles()
Get the names of the class files, baseClass depends on
Specified by:
getIncludedFiles in interface FileScanner
Overrides:
getIncludedFiles in interface DirectoryScanner

Returns:
the names of the files


getNotIncludedDirectories

public String[] getNotIncludedDirectories()
Specified by:
getNotIncludedDirectories in interface FileScanner
Overrides:
getNotIncludedDirectories in interface DirectoryScanner

See Also:
DirectoryScanner.getNotIncludedDirectories()


getNotIncludedFiles

public String[] getNotIncludedFiles()
Specified by:
getNotIncludedFiles in interface FileScanner
Overrides:
getNotIncludedFiles in interface DirectoryScanner

See Also:
DirectoryScanner.getNotIncludedFiles()


scan

public void scan()
            throws IllegalStateException
Scans the base directory for files that baseClass depends on
Specified by:
scan in interface FileScanner
Overrides:
scan in interface DirectoryScanner


setBasedir

public void setBasedir(File basedir)
Sets the basedir for scanning. This is the directory that is scanned recursively.
Specified by:
setBasedir in interface FileScanner
Overrides:
setBasedir in interface DirectoryScanner

Parameters:
basedir - the basedir for scanning


setCaseSensitive

public void setCaseSensitive(boolean isCaseSensitive)
Specified by:
setCaseSensitive in interface FileScanner
Overrides:
setCaseSensitive in interface DirectoryScanner

See Also:
DirectoryScanner.setCaseSensitive(boolean)


setExcludes

public void setExcludes(String[] excludes)
Specified by:
setExcludes in interface FileScanner
Overrides:
setExcludes in interface DirectoryScanner

See Also:
DirectoryScanner.setExcludes(String[])


setIncludes

public void setIncludes(String[] includes)
Specified by:
setIncludes in interface FileScanner
Overrides:
setIncludes in interface DirectoryScanner

See Also:
DirectoryScanner.setIncludes(String[])


setRootClasses

public void setRootClasses(Vector rootClasses)
Sets the root classes to be used to drive the scan.

Parameters:
rootClasses - the rootClasses to be used for this scan


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.