org.apache.tools.ant.util.depend

Class AbstractAnalyzer

public abstract class AbstractAnalyzer extends Object implements DependencyAnalyzer

An abstract implementation of the analyzer interface providing support for the bulk of interface methods.
Field Summary
static intMAX_LOOPS
Maximum number of loops for looking for indirect dependencies.
Constructor Summary
protected AbstractAnalyzer()
Setup the analyzer
Method Summary
voidaddClassPath(Path classPath)
Add a classpath to the classpath being used by the analyzer.
voidaddRootClass(String className)
Add a root class.
voidaddSourcePath(Path sourcePath)
Add a source path to the source path used by this analyzer.
voidconfig(String name, Object info)
Configure an aspect of the analyzer.
protected abstract voiddetermineDependencies(Vector files, Vector classes)
Determine the dependencies of the current set of root classes
FilegetClassContainer(String classname)
Get the file that contains the class definition
EnumerationgetClassDependencies()
Get the list of classes upon which root classes depend.
EnumerationgetFileDependencies()
Get the list of files in the file system upon which the root classes depend.
protected EnumerationgetRootClasses()
Get an enumeration of the root classes
FilegetSourceContainer(String classname)
Get the file that contains the class source.
protected booleanisClosureRequired()
Indicate if the analyzer is required to follow indirect class relationships.
voidreset()
Reset the dependency list.
voidsetClosure(boolean closure)
Set the closure flag.
protected abstract booleansupportsFileDependencies()
Indicate if the particular subclass supports file dependency information.

Field Detail

MAX_LOOPS

public static final int MAX_LOOPS
Maximum number of loops for looking for indirect dependencies.

Constructor Detail

AbstractAnalyzer

protected AbstractAnalyzer()
Setup the analyzer

Method Detail

addClassPath

public void addClassPath(Path classPath)
Add a classpath to the classpath being used by the analyzer. The classpath contains the binary classfiles for the classes being analyzed The elements may either be the directories or jar files.Not all analyzers will use this information.

Parameters: classPath the Path instance specifying the classpath elements

addRootClass

public void addRootClass(String className)
Add a root class. The root classes are used to drive the determination of dependency information. The analyzer will start at the root classes and add dependencies from there.

Parameters: className the name of the class in Java dot notation.

addSourcePath

public void addSourcePath(Path sourcePath)
Add a source path to the source path used by this analyzer. The elements in the given path contain the source files for the classes being analyzed. Not all analyzers will use this information.

Parameters: sourcePath The Path instance specifying the source path elements.

config

public void config(String name, Object info)
Configure an aspect of the analyzer. The set of aspects that are supported is specific to each analyzer instance.

Parameters: name the name of the aspect being configured info the configuration info.

determineDependencies

protected abstract void determineDependencies(Vector files, Vector classes)
Determine the dependencies of the current set of root classes

Parameters: files a vector into which Files upon which the root classes depend should be placed. classes a vector of Strings into which the names of classes upon which the root classes depend should be placed.

getClassContainer

public File getClassContainer(String classname)
Get the file that contains the class definition

Parameters: classname the name of the required class

Returns: the file instance, zip or class, containing the class or null if the class could not be found.

Throws: IOException if the files in the classpath cannot be read.

getClassDependencies

public Enumeration getClassDependencies()
Get the list of classes upon which root classes depend. This is a list of Java classnames in dot notation.

Returns: an enumeration of Strings, each being the name of a Java class in dot notation.

getFileDependencies

public Enumeration getFileDependencies()
Get the list of files in the file system upon which the root classes depend. The files will be either the classfiles or jar files upon which the root classes depend.

Returns: an enumeration of File instances.

getRootClasses

protected Enumeration getRootClasses()
Get an enumeration of the root classes

Returns: an enumeration of Strings, each of which is a class name for a root class.

getSourceContainer

public File getSourceContainer(String classname)
Get the file that contains the class source.

Parameters: classname the name of the required class

Returns: the file instance, zip or java, containing the source or null if the source for the class could not be found.

Throws: IOException if the files in the sourcepath cannot be read.

isClosureRequired

protected boolean isClosureRequired()
Indicate if the analyzer is required to follow indirect class relationships.

Returns: true if indirect relationships should be followed.

reset

public void reset()
Reset the dependency list. This will reset the determined dependencies and the also list of root classes.

setClosure

public void setClosure(boolean closure)
Set the closure flag. If this flag is true the analyzer will traverse all class relationships until it has collected the entire set of direct and indirect dependencies

Parameters: closure true if dependencies should be traversed to determine indirect dependencies.

supportsFileDependencies

protected abstract boolean supportsFileDependencies()
Indicate if the particular subclass supports file dependency information.

Returns: true if file dependencies are supported.

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