edu.umd.cs.findbugs.plan

Class AnalysisPass

public class AnalysisPass extends Object

An analysis pass in the overall ExecutionPlan. This is a list of Detectors to be applied to analyzed classes.

Author: David Hovemeyer

See Also: ExecutionPlan

Constructor Summary
AnalysisPass()
Constructor.
Method Summary
voidaddToPass(DetectorFactory factory)
Make given DetectorFactory a member of this pass.
voidappend(DetectorFactory factory)
Append the given DetectorFactory to the end of the ordered detector list.
booleancontains(DetectorFactory factory)
Return whether or not this pass contains the given DetectorFactory.
Collection<DetectorFactory>getMembers()
Get the members of this pass.
Set<DetectorFactory>getUnpositionedMembers()
Get Set of pass members which haven't been assigned a position in the pass.
Detector2[]instantiateDetector2sInPass(BugReporter bugReporter)
Instantiate all of the Detector2s in this pass and return them in a (correctly-ordered) array.
Detector[]instantiateDetectorsInPass(BugReporter bugReporter)
Instantiate all of the detectors in this pass as objects implementing the BCEL-only Detector interface.
Iterator<DetectorFactory>iterator()
Get an Iterator over the DetectorFactory objects in the pass, in their assigned order.

Constructor Detail

AnalysisPass

public AnalysisPass()
Constructor. Creates an empty analysis pass.

Method Detail

addToPass

public void addToPass(DetectorFactory factory)
Make given DetectorFactory a member of this pass. Does not position the factory within the overall list of detectors.

Parameters: factory a DetectorFactory

append

public void append(DetectorFactory factory)
Append the given DetectorFactory to the end of the ordered detector list. The factory must be a member of the pass.

Parameters: factory a DetectorFactory

contains

public boolean contains(DetectorFactory factory)
Return whether or not this pass contains the given DetectorFactory.

Parameters: factory the DetectorFactory

Returns: true if this pass contains the DetectorFactory, false if not

getMembers

public Collection<DetectorFactory> getMembers()
Get the members of this pass.

Returns: members of this pass

getUnpositionedMembers

public Set<DetectorFactory> getUnpositionedMembers()
Get Set of pass members which haven't been assigned a position in the pass.

instantiateDetector2sInPass

public Detector2[] instantiateDetector2sInPass(BugReporter bugReporter)
Instantiate all of the Detector2s in this pass and return them in a (correctly-ordered) array.

Parameters: bugReporter the BugReporter

Returns: array of Detector2s

instantiateDetectorsInPass

public Detector[] instantiateDetectorsInPass(BugReporter bugReporter)

Deprecated: call instantiateDetector2sInPass() instead

Instantiate all of the detectors in this pass as objects implementing the BCEL-only Detector interface. Detectors that do not support this interface will not be created. Therefore, new code should use the instantiateDetector2sInPass() method, which can support all detectors.

Parameters: bugReporter the BugReporter

Returns: array of Detectors

iterator

public Iterator<DetectorFactory> iterator()
Get an Iterator over the DetectorFactory objects in the pass, in their assigned order.
FindBugs™ is licenced under the LGPL. Copyright © 2006 University of Maryland.