org.fuin.units4j.dependency
Class DependencyAnalyzer

java.lang.Object
  org.fuin.units4j.dependency.DependencyAnalyzer

public final class DependencyAnalyzer
extends Object

Analyzes package dependencies.

Constructor Summary

DependencyAnalyzer(Class<?> clasz, String dependenciesFilePathAndName)
Constructor with XML resource.

DependencyAnalyzer(Dependencies dependencies)
Constructor with dependency definition.

DependencyAnalyzer(File dependenciesFile)
Constructor with XML file.

Method Summary

void	analyze(File classesDir) Analyze the dependencies for all classes in the directory and it's sub directories.
Dependencies	getDependencies() Returns the dependency definition.
List<DependencyError>	getDependencyErrors() Returns the list of dependency errors from last call to analyze(File).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DependencyAnalyzer

public DependencyAnalyzer(File dependenciesFile)
                   throws InvalidDependenciesDefinitionException

Constructor with XML file.

Parameters:

dependenciesFile - XML file with allowed or forbidden dependencies - Cannot be null.

Throws:

InvalidDependenciesDefinitionException - Formal correct (XML) but invalid dependency definition.

DependencyAnalyzer

public DependencyAnalyzer(Class<?> clasz,
                          String dependenciesFilePathAndName)
                   throws InvalidDependenciesDefinitionException

Constructor with XML resource.

Parameters:

clasz - Class to use for loading the resource - Cannot be null.

dependenciesFilePathAndName - XML resource (path/name) with allowed or forbidden dependencies - Cannot be null.

Throws:

InvalidDependenciesDefinitionException - Formal correct (XML) but invalid dependency definition.

DependencyAnalyzer

public DependencyAnalyzer(Dependencies dependencies)
                   throws InvalidDependenciesDefinitionException

Constructor with dependency definition.

Parameters:

dependencies - Definition of allowed or forbidden dependencies - Cannot be null.

Throws:

InvalidDependenciesDefinitionException - Formal correct (XML) but invalid dependency definition.

Method Detail

analyze

public final void analyze(File classesDir)
                   throws IOException

Analyze the dependencies for all classes in the directory and it's sub directories.

Parameters:

classesDir - Directory where the "*.class" files are located (something like "bin" or "classes").

Throws:

IOException - Error reading the classes.

getDependencyErrors

public final List<DependencyError> getDependencyErrors()

Returns the list of dependency errors from last call to analyze(File).

Returns:

List of errors - Always non-null but may be empty.

getDependencies

public final Dependencies getDependencies()

Returns the dependency definition.

Returns:

Definition of allowed or forbidden dependencies - Never null.