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

Class AnalyzableElementDependantsDetector<TAnalyzableElement extends IAnalyzableElement>

java.lang.Object

org.pfsw.tools.cda.core.dependency.analyzer.AnalyzableElementDependantsDetector<TAnalyzableElement>

All Implemented Interfaces:

org.pfsw.bif.filter.IObjectFilter<TAnalyzableElement>, IAnalyzableElementProcessor<TAnalyzableElement>, IMutableAnalyzableElementProcessor<TAnalyzableElement>, InterruptableProcessor<TAnalyzableElement>

Direct Known Subclasses:

AClassDependencyDetector, ContainerDependantsDetector, PackageDependantsDetector

public abstract class AnalyzableElementDependantsDetector<TAnalyzableElement extends IAnalyzableElement>
extends java.lang.Object
implements IMutableAnalyzableElementProcessor<TAnalyzableElement>

A generic super class that implements dependency detection on IAnalyzableElements.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnalyzableElementDependantsDetector(IProgressMonitor progressMonitor, TAnalyzableElement element) Initialize the new instance with default values.

Method Summary

Modifier and Type	Method and Description
protected boolean	doMonitoring(java.lang.String itemName) Handles updating the progress monitor if one is available.
TAnalyzableElement	getAnalyzedElement()
java.util.Collection<TAnalyzableElement>	getExcludedElements()
protected IProgressMonitor	getMonitor()
protected boolean	hasMonitor()
protected boolean	isExcluded(TAnalyzableElement element)
boolean	matches(TAnalyzableElement element) Returns true if the given element matches the criteria of this detector.
boolean	process(TAnalyzableElement element) Process the given element.
void	setAnalyzedElement(TAnalyzableElement newValue) Set the element to be analyzed to a new value (must not null).
void	setExcludedElements(java.util.Collection<TAnalyzableElement> elements) Set a collection of elements that must be skipped in the matches() method.
protected void	setMonitor(IProgressMonitor newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzableElementDependantsDetector

protected AnalyzableElementDependantsDetector(IProgressMonitor progressMonitor,
                                              TAnalyzableElement element)

Initialize the new instance with default values.

Method Detail

getAnalyzedElement

public TAnalyzableElement getAnalyzedElement()

setAnalyzedElement

public void setAnalyzedElement(TAnalyzableElement newValue)

Description copied from interface: IMutableAnalyzableElementProcessor

Set the element to be analyzed to a new value (must not null).

Specified by:

setAnalyzedElement in interface IMutableAnalyzableElementProcessor<TAnalyzableElement extends IAnalyzableElement>

getExcludedElements

public java.util.Collection<TAnalyzableElement> getExcludedElements()

setExcludedElements

public void setExcludedElements(java.util.Collection<TAnalyzableElement> elements)

Description copied from interface: IMutableAnalyzableElementProcessor

Set a collection of elements that must be skipped in the matches() method. That is, they will be excluded from the final result collection.

Specified by:

setExcludedElements in interface IMutableAnalyzableElementProcessor<TAnalyzableElement extends IAnalyzableElement>

Parameters:

elements - The collection of excluded elements (must not be null).

process

public boolean process(TAnalyzableElement element)

Process the given element. Returns true if processing must continue.

Specified by:

process in interface InterruptableProcessor<TAnalyzableElement extends IAnalyzableElement>

Parameters:

element - The object to be processed (never null).

Returns:

true to continue the processing, false to stop the processing.

matches

public boolean matches(TAnalyzableElement element)

Returns true if the given element matches the criteria of this detector.

Specified by:

matches in interface org.pfsw.bif.filter.IObjectFilter<TAnalyzableElement extends IAnalyzableElement>

Specified by:

matches in interface IAnalyzableElementProcessor<TAnalyzableElement extends IAnalyzableElement>

Parameters:

element - Any element object or even null

isExcluded

protected boolean isExcluded(TAnalyzableElement element)

hasMonitor

protected boolean hasMonitor()

doMonitoring

protected boolean doMonitoring(java.lang.String itemName)

Handles updating the progress monitor if one is available. Returns true if processing should continue.

getMonitor

protected IProgressMonitor getMonitor()

setMonitor

protected void setMonitor(IProgressMonitor newValue)