| org.apache.tools.ant.util.depend.DependencyAnalyzer
All known Subclasses: org.apache.tools.ant.util.depend.AbstractAnalyzer,
| DependencyAnalyzer | | public interface DependencyAnalyzer (Code) | | A dependency analyzer analyzes dependencies between Java classes to
determine the minimal set of classes which are required by a set of
"root" classes. Different implementations of this interface can
use different strategies and libraries to determine the required set. For
example, some analyzers will use class files while others might use
source files. Analyzer specific configuration is catered for through a
generic configure method
|
| addClassPath | | void addClassPath(Path classpath)(Code) | | 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 | | void addRootClass(String classname)(Code) | | 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 | | void addSourcePath(Path sourcePath)(Code) | | 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 pathelements. |
| config | | void config(String name, Object info)(Code) | | 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
Parameters:
info - the configuration information. |
| getClassContainer | | File getClassContainer(String classname) throws IOException(Code) | | Get the file that contains the class definition
Parameters:
classname - the name of the required class the file instance, zip or class, containing theclass or null if the class could not be found.
exception:
IOException - if the files in the classpath cannot be read. |
| getClassDependencies | | Enumeration getClassDependencies()(Code) | | Get the list of classes upon which root classes depend. This is a
list of Java classnames in dot notation.
an enumeration of Strings, each being the name of a Javaclass in dot notation. |
| getFileDependencies | | Enumeration getFileDependencies()(Code) | | 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.
an enumeration of File instances. |
| getSourceContainer | | File getSourceContainer(String classname) throws IOException(Code) | | Get the file that contains the class source.
Parameters:
classname - the name of the required class the file instance, zip or java, containing thesource or null if the source for the class could not be found.
exception:
IOException - if the files in the sourcepath cannot be read. |
| reset | | void reset()(Code) | | Reset the dependency list. This will reset the determined
dependencies and the also list of root classes.
|
| setClosure | | void setClosure(boolean closure)(Code) | | 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 determineindirect dependencies. |
|
|