Package org.apache.tools.ant.util.depend
Class AbstractAnalyzer
java.lang.Object
org.apache.tools.ant.util.depend.AbstractAnalyzer
- All Implemented Interfaces:
- DependencyAnalyzer
- Direct Known Subclasses:
- AncestorAnalyzer,- AntAnalyzer,- FullAnalyzer
An abstract implementation of the analyzer interface providing support
 for the bulk of interface methods.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intMaximum number of loops for looking for indirect dependencies.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddClassPath(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.voidConfigure an aspect of the analyzer.protected abstract voiddetermineDependencies(Vector<File> files, Vector<String> classes) Determine the dependencies of the current set of root classesgetClassContainer(String classname) Get the file that contains the class definitionGet the list of classes upon which root classes depend.Get the list of files in the file system upon which the root classes depend.protected Enumeration<String>Get an enumeration of the root classesgetSourceContainer(String classname) Get the file that contains the class source.protected booleanIndicate if the analyzer is required to follow indirect class relationships.voidreset()Reset the dependency list.voidsetClosure(boolean closure) Set the closure flag.protected abstract booleanIndicate if the particular subclass supports file dependency information.
- 
Field Details- 
MAX_LOOPSpublic static final int MAX_LOOPSMaximum number of loops for looking for indirect dependencies.- See Also:
 
 
- 
- 
Constructor Details- 
AbstractAnalyzerprotected AbstractAnalyzer()Setup the analyzer
 
- 
- 
Method Details- 
setClosurepublic 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- Specified by:
- setClosurein interface- DependencyAnalyzer
- Parameters:
- closure- true if dependencies should be traversed to determine indirect dependencies.
 
- 
getFileDependenciesGet 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.- Specified by:
- getFileDependenciesin interface- DependencyAnalyzer
- Returns:
- an enumeration of File instances.
 
- 
getClassDependenciesGet the list of classes upon which root classes depend. This is a list of Java classnames in dot notation.- Specified by:
- getClassDependenciesin interface- DependencyAnalyzer
- Returns:
- an enumeration of Strings, each being the name of a Java class in dot notation.
 
- 
getClassContainerGet the file that contains the class definition- Specified by:
- getClassContainerin interface- DependencyAnalyzer
- 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.
 
- 
getSourceContainerGet the file that contains the class source.- Specified by:
- getSourceContainerin interface- DependencyAnalyzer
- 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.
 
- 
addSourcePathAdd 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.- Specified by:
- addSourcePathin interface- DependencyAnalyzer
- Parameters:
- sourcePath- The Path instance specifying the source path elements.
 
- 
addClassPathAdd 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.- Specified by:
- addClassPathin interface- DependencyAnalyzer
- Parameters:
- classPath- the Path instance specifying the classpath elements
 
- 
addRootClassAdd 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.- Specified by:
- addRootClassin interface- DependencyAnalyzer
- Parameters:
- className- the name of the class in Java dot notation.
 
- 
configConfigure an aspect of the analyzer. The set of aspects that are supported is specific to each analyzer instance.- Specified by:
- configin interface- DependencyAnalyzer
- Parameters:
- name- the name of the aspect being configured
- info- the configuration info.
 
- 
resetpublic void reset()Reset the dependency list. This will reset the determined dependencies and the also list of root classes.- Specified by:
- resetin interface- DependencyAnalyzer
 
- 
getRootClassesGet an enumeration of the root classes- Returns:
- an enumeration of Strings, each of which is a class name for a root class.
 
- 
isClosureRequiredprotected boolean isClosureRequired()Indicate if the analyzer is required to follow indirect class relationships.- Returns:
- true if indirect relationships should be followed.
 
- 
determineDependenciesDetermine 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.
 
- 
supportsFileDependenciesprotected abstract boolean supportsFileDependencies()Indicate if the particular subclass supports file dependency information.- Returns:
- true if file dependencies are supported.
 
 
-