org.pfsw.tools.cda.core.dependency.analyzer

Class CircularDependenciesDetector

java.lang.Object

org.pfsw.tools.cda.core.dependency.analyzer.MonitoredDependencyAnalyzer

org.pfsw.tools.cda.core.dependency.analyzer.CircularDependenciesDetector

public class CircularDependenciesDetector
extends MonitoredDependencyAnalyzer

This class is responsible to analyze a given array of classes (types) and detect all circular dependencies.

Constructor Summary

Constructors

Constructor and Description
CircularDependenciesDetector(IAnalyzableElement elementToAnalyze) Initialize the new instance with an element to analyze.
CircularDependenciesDetector(IAnalyzableElement elementToAnalyze, IProgressMonitor monitor) Initialize the new instance with an element to analyze and a monitor.

Method Summary

Modifier and Type	Method and Description
CircularDependenciesDetector	analyze() Starts the analyzing of the underlying element and all its contained classes.
protected boolean	areAllInSameContainer(ClassInformation[] classInfos)
protected boolean	areAllInSamePackage(ClassInformation[] classInfos)
protected boolean	areAllInSamePackageBranch(ClassInformation[] classInfos)
protected org.pfsw.util.CollectionUtil	coll()
protected void	collectCircularDependencyPaths(ClassInformation[] classInfos) Collects all the circular dependency paths for each of the given classes.
protected void	debugPrint(ClassInformation[] path)
CircularDependenciesResult	detectCircularDependencies(ClassInformation... classInfos) Detect all the circular dependency paths for each of the given classes.
protected void	findCircularDependencyPaths(ProcessingClassNode startNode, ClassInformation[] classInfos) Collects all the circular dependency paths between the given start class and any of the given classes or referred classes of these.
protected ProcessingClassNode	findOrCreate(ClassInformation classInfo) Looks for the given class in the class registry and returns the corresponding ProcessingClassNode.
protected java.util.Map<ClassInformation,ProcessingClassNode>	getNodeRegistry()
protected java.util.Stack<ProcessingClassNode>	getNodeStack()
int	getNumberOfElementsToAnalyze() Returns the number of elements this analyzer is processing.
CircularDependenciesResult	getResult() returns the result of the last detectCircularDependencies(ClassInformation...) or analyze() execution.
protected boolean	ignoreCyclesInSameContainer()
protected boolean	ignoreCyclesInSamePackage()
protected boolean	ignoreCyclesInSamePackageBranch()
protected boolean	ignoreThirdPartyLibraries()
protected int	indexOfTopLevelClass(ClassInformation[] classInfos)
protected boolean	isInnerClassDependencyCycle(ClassInformation[] path)
protected void	keepCircularDependency(ProcessingClassNode classNode)
protected void	resetRegisteredNodes() Reset the state of all registered class nodes to new.
void	setIgnoreCyclesInSameContainer(boolean newValue)
void	setIgnoreCyclesInSamePackage(boolean newValue)
void	setIgnoreCyclesInSamePackageBranch(boolean newValue)
void	setIgnoreThirdPartyLibraries(boolean newValue)
protected void	setNodeRegistry(java.util.Map<ClassInformation,ProcessingClassNode> newValue)
protected void	setNodeStack(java.util.Stack<ProcessingClassNode> newValue)
protected void	setResult(CircularDependenciesResult newValue)
protected java.lang.String	shortestPackageName(ClassInformation[] classInfos)
protected ClassInformation[]	stackToArray()

Methods inherited from class org.pfsw.tools.cda.core.dependency.analyzer.MonitoredDependencyAnalyzer

getAnalyzedElement, getProgressMonitor, getWorkset, isCancelled, resetProcessingCounter, setAnalyzedElement, setIsCancelled, setProgressMonitor, showProgress

Methods inherited from class java.lang.Object

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

Constructor Detail

CircularDependenciesDetector

public CircularDependenciesDetector(IAnalyzableElement elementToAnalyze)

Initialize the new instance with an element to analyze.

CircularDependenciesDetector

public CircularDependenciesDetector(IAnalyzableElement elementToAnalyze,
                                    IProgressMonitor monitor)

Initialize the new instance with an element to analyze and a monitor.

Method Detail

analyze

public CircularDependenciesDetector analyze()

Starts the analyzing of the underlying element and all its contained classes.

Specified by:

analyze in class MonitoredDependencyAnalyzer

getNumberOfElementsToAnalyze

public int getNumberOfElementsToAnalyze()

Returns the number of elements this analyzer is processing.

Specified by:

getNumberOfElementsToAnalyze in class MonitoredDependencyAnalyzer

detectCircularDependencies

public CircularDependenciesResult detectCircularDependencies(ClassInformation... classInfos)

Detect all the circular dependency paths for each of the given classes.

Returns:

A result object containing all found circular dependency paths.

setIgnoreCyclesInSamePackage

public void setIgnoreCyclesInSamePackage(boolean newValue)

getResult

public CircularDependenciesResult getResult()

returns the result of the last detectCircularDependencies(ClassInformation...) or analyze() execution.

setIgnoreCyclesInSamePackageBranch

public void setIgnoreCyclesInSamePackageBranch(boolean newValue)

setIgnoreCyclesInSameContainer

public void setIgnoreCyclesInSameContainer(boolean newValue)

setIgnoreThirdPartyLibraries

public void setIgnoreThirdPartyLibraries(boolean newValue)

collectCircularDependencyPaths

protected void collectCircularDependencyPaths(ClassInformation[] classInfos)

Collects all the circular dependency paths for each of the given classes.

findCircularDependencyPaths

protected void findCircularDependencyPaths(ProcessingClassNode startNode,
                                           ClassInformation[] classInfos)

Collects all the circular dependency paths between the given start class and any of the given classes or referred classes of these.

findOrCreate

protected ProcessingClassNode findOrCreate(ClassInformation classInfo)

Looks for the given class in the class registry and returns the corresponding ProcessingClassNode. If the class is not yet registered than a new ProcessingClassNode gets created on it and will be registered. Eventually this new ProcessingClassNode will be returned.

resetRegisteredNodes

protected void resetRegisteredNodes()

Reset the state of all registered class nodes to new.

keepCircularDependency

protected void keepCircularDependency(ProcessingClassNode classNode)

stackToArray

protected ClassInformation[] stackToArray()

isInnerClassDependencyCycle

protected boolean isInnerClassDependencyCycle(ClassInformation[] path)

areAllInSamePackage

protected boolean areAllInSamePackage(ClassInformation[] classInfos)

areAllInSamePackageBranch

protected boolean areAllInSamePackageBranch(ClassInformation[] classInfos)

areAllInSameContainer

protected boolean areAllInSameContainer(ClassInformation[] classInfos)

indexOfTopLevelClass

protected int indexOfTopLevelClass(ClassInformation[] classInfos)

shortestPackageName

protected java.lang.String shortestPackageName(ClassInformation[] classInfos)

debugPrint

protected void debugPrint(ClassInformation[] path)

getNodeRegistry

protected java.util.Map<ClassInformation,ProcessingClassNode> getNodeRegistry()

setNodeRegistry

protected void setNodeRegistry(java.util.Map<ClassInformation,ProcessingClassNode> newValue)

getNodeStack

protected java.util.Stack<ProcessingClassNode> getNodeStack()

setNodeStack

protected void setNodeStack(java.util.Stack<ProcessingClassNode> newValue)

setResult

protected void setResult(CircularDependenciesResult newValue)

ignoreCyclesInSamePackage

protected boolean ignoreCyclesInSamePackage()

ignoreCyclesInSamePackageBranch

protected boolean ignoreCyclesInSamePackageBranch()

ignoreCyclesInSameContainer

protected boolean ignoreCyclesInSameContainer()

ignoreThirdPartyLibraries

protected boolean ignoreThirdPartyLibraries()

coll

protected org.pfsw.util.CollectionUtil coll()