Class ExecutionPlan

java.lang.Object

edu.umd.cs.findbugs.plan.ExecutionPlan

public class ExecutionPlan
extends Object

A plan for executing Detectors on an application. Automatically assigns Detectors to passes and orders Detectors within each pass based on ordering constraints specified in the plugin descriptor(s).

Field Summary

Fields

Modifier and Type	Field	Description
private Set<DetectorFactory>	assignedToPassSet
static final boolean	DEBUG
private DetectorFactoryChooser	factoryChooser
private Map<String, DetectorFactory>	factoryMap
private List<DetectorOrderingConstraint>	interPassConstraintList
private List<DetectorOrderingConstraint>	intraPassConstraintList
private LinkedList<AnalysisPass>	passList
private List<Plugin>	pluginList

Constructor Summary

Constructors

Constructor	Description
ExecutionPlan()	Constructor.

Method Summary

Modifier and Type	Method	Description
private DetectorNode	addOrCreateDetectorNode(DetectorFactory factory, Map<String, DetectorNode> nodeMap, ConstraintGraph constraintGraph)
private Set<DetectorNode>	addOrCreateDetectorNodes(DetectorFactorySelector selector, Map<String, DetectorNode> nodeMap, Set<DetectorFactory> factorySet, ConstraintGraph constraintGraph)
private void	addPass(AnalysisPass pass)
void	addPlugin(Plugin plugin)	Add a Plugin whose Detectors should be added to the execution plan.
private void	appendDetectorsToPass(Collection<DetectorFactory> detectorSet, AnalysisPass pass)
private void	appendToPass(DetectorFactory factory, AnalysisPass pass)	Append a DetectorFactory to the end position in an AnalysisPass.
private void	assignToPass(DetectorFactory factory, AnalysisPass pass)	Make a DetectorFactory a member of an AnalysisPass.
void	build()	Build the execution plan.
private ConstraintGraph	buildConstraintGraph(Map<String, DetectorNode> nodeMap, Set<DetectorFactory> factorySet, List<DetectorOrderingConstraint> constraintList)	Build a constraint graph.
private void	buildPassList(ConstraintGraph constraintGraph)
private static <T> void	copyTo(Iterator<T> iter, Collection<T> dest)
private void	createConstraintEdges(ConstraintGraph result, Set<DetectorNode> earlierSet, Set<DetectorNode> laterSet, DetectorOrderingConstraint constraint)
void	dispose()
private void	dumpGraph(ConstraintGraph graph)
DetectorFactoryChooser	getFactoryChooser()
int	getNumPasses()	Get the number of passes in the execution plan.
private Set<DetectorFactory>	getUnassignedSet()
boolean	isActive(Class<? extends Detector> detectorClass)
boolean	isActive(String detectorClass)
static void	main(String[] argv)
Iterator<AnalysisPass>	passIterator()	Get an Iterator over the AnalysisPasses.
private void	print()
private Set<DetectorFactory>	selectDetectors(DetectorFactorySelector selector, Set<DetectorFactory> candidateSet)
void	setDetectorFactoryChooser(DetectorFactoryChooser factoryChooser)	Set the DetectorFactoryChooser to use to select which detectors to enable.
private void	sortPass(List<DetectorOrderingConstraint> constraintList, Map<String, DetectorFactory> factoryMap, AnalysisPass pass)

Methods inherited from class Object

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

Field Details

DEBUG

public static final boolean DEBUG

pluginList

private List<Plugin> pluginList

factoryChooser

private DetectorFactoryChooser factoryChooser

passList

private LinkedList<AnalysisPass> passList

factoryMap

private Map<String, DetectorFactory> factoryMap

interPassConstraintList

private List<DetectorOrderingConstraint> interPassConstraintList

intraPassConstraintList

private List<DetectorOrderingConstraint> intraPassConstraintList

assignedToPassSet

private Set<DetectorFactory> assignedToPassSet

Constructor Details

ExecutionPlan

public ExecutionPlan()

Constructor. Creates an empty plan.

Method Details

dispose

public void dispose()

setDetectorFactoryChooser

public void setDetectorFactoryChooser(DetectorFactoryChooser factoryChooser)

Set the DetectorFactoryChooser to use to select which detectors to enable. This must be called before any Plugins are added to the execution plan.

isActive

public boolean isActive(@DottedClassName
 String detectorClass)

isActive

public boolean isActive(Class<? extends Detector> detectorClass)

addPlugin

public void addPlugin(Plugin plugin)
               throws OrderingConstraintException

Add a Plugin whose Detectors should be added to the execution plan.

Throws:

OrderingConstraintException

build

public void build()
           throws OrderingConstraintException

Build the execution plan. Using the ordering constraints specified in the plugin descriptor(s), assigns Detectors to passes and orders the Detectors within those passes.

Throws:

OrderingConstraintException

passIterator

public Iterator<AnalysisPass> passIterator()

Get an Iterator over the AnalysisPasses.

getNumPasses

public int getNumPasses()

Get the number of passes in the execution plan.

Returns:

the number of passes in the execution plan

copyTo

private static <T> void copyTo(Iterator<T> iter,
 Collection<T> dest)

buildConstraintGraph

private ConstraintGraph buildConstraintGraph(Map<String, DetectorNode> nodeMap,
 Set<DetectorFactory> factorySet,
 List<DetectorOrderingConstraint> constraintList)

Build a constraint graph. This represents ordering constraints between Detectors. A topological sort of the constraint graph will yield a correct ordering of the detectors (which may mean either passes or an ordering within a single pass, depending on whether the constraints are inter-pass or intra-pass).

Parameters:

nodeMap - map to be populated with detector class names to constraint graph nodes for those detectors

factorySet - build the graph using these DetectorFactories as nodes

constraintList - List of ordering constraints

Returns:

the ConstraintGraph

selectDetectors

private Set<DetectorFactory> selectDetectors(DetectorFactorySelector selector,
 Set<DetectorFactory> candidateSet)

addOrCreateDetectorNodes

private Set<DetectorNode> addOrCreateDetectorNodes(DetectorFactorySelector selector,
 Map<String, DetectorNode> nodeMap,
 Set<DetectorFactory> factorySet,
 ConstraintGraph constraintGraph)

addOrCreateDetectorNode

private DetectorNode addOrCreateDetectorNode(DetectorFactory factory,
 Map<String, DetectorNode> nodeMap,
 ConstraintGraph constraintGraph)

createConstraintEdges

private void createConstraintEdges(ConstraintGraph result,
 Set<DetectorNode> earlierSet,
 Set<DetectorNode> laterSet,
 DetectorOrderingConstraint constraint)

buildPassList

private void buildPassList(ConstraintGraph constraintGraph)
                    throws OrderingConstraintException

Throws:

OrderingConstraintException

addPass

private void addPass(AnalysisPass pass)

sortPass

private void sortPass(List<DetectorOrderingConstraint> constraintList,
 Map<String, DetectorFactory> factoryMap,
 AnalysisPass pass)
               throws OrderingConstraintException

Throws:

OrderingConstraintException

getUnassignedSet

private Set<DetectorFactory> getUnassignedSet()

assignToPass

private void assignToPass(DetectorFactory factory,
 AnalysisPass pass)

Make a DetectorFactory a member of an AnalysisPass.

appendToPass

private void appendToPass(DetectorFactory factory,
 AnalysisPass pass)

Append a DetectorFactory to the end position in an AnalysisPass. The DetectorFactory must be a member of the pass.

appendDetectorsToPass

private void appendDetectorsToPass(Collection<DetectorFactory> detectorSet,
 AnalysisPass pass)

print

private void print()

dumpGraph

private void dumpGraph(ConstraintGraph graph)

main

public static void main(String[] argv)
                 throws Exception

Throws:

Exception

getFactoryChooser

@NonNull
public DetectorFactoryChooser getFactoryChooser()

Returns:

Returns the factoryChooser used during analysis.