Class BugAccumulator

java.lang.Object

edu.umd.cs.findbugs.BugAccumulator

public class BugAccumulator
extends Object

Accumulate warnings that may occur at multiple source locations, consolidating them into a single warning.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BugAccumulator.Data

Field Summary

Fields

Modifier and Type	Field	Description
private final HashMap<String, BugInstance>	hashes
private BugInstance	lastBug
private SourceLineAnnotation	lastSourceLine
private final Map<BugInstance, BugAccumulator.Data>	map
private final boolean	performAccumulation
private final BugReporter	reporter

Constructor Summary

Constructors

Constructor	Description
BugAccumulator(BugReporter reporter)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	accumulateBug(BugInstance bug, ClassContext classContext, org.apache.bcel.classfile.Method method, Location location)
void	accumulateBug(BugInstance bug, ClassContext classContext, org.apache.bcel.generic.MethodGen methodGen, String sourceFile, Location location)
void	accumulateBug(BugInstance bug, BytecodeScanningDetector visitor)	Accumulate a warning at source location currently being visited by given BytecodeScanningDetector.
void	accumulateBug(BugInstance bug, SourceLineAnnotation sourceLine)	Accumulate a warning at given source location.
void	clearBugs()	Clear all accumulated bugs without reporting them
void	forgetLastBug()
SourceLineAnnotation	getLastBugLocation()
Iterable<? extends SourceLineAnnotation>	locations(BugInstance bug)
void	reportAccumulatedBugs()	Report accumulated warnings to the BugReporter.
void	reportBug(BugInstance bug, BugAccumulator.Data d)
Iterable<? extends BugInstance>	uniqueBugs()

Methods inherited from class Object

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

Field Details

reporter

private final BugReporter reporter

performAccumulation

private final boolean performAccumulation

map

private final Map<BugInstance, BugAccumulator.Data> map

hashes

private final HashMap<String, BugInstance> hashes

lastBug

private BugInstance lastBug

lastSourceLine

private SourceLineAnnotation lastSourceLine

Constructor Details

BugAccumulator

public BugAccumulator(BugReporter reporter)

Constructor.

Parameters:

reporter - the BugReporter to which warnings should eventually be reported

Method Details

getLastBugLocation

@CheckForNull
public SourceLineAnnotation getLastBugLocation()

forgetLastBug

public void forgetLastBug()

accumulateBug

public void accumulateBug(BugInstance bug,
 SourceLineAnnotation sourceLine)

Accumulate a warning at given source location.

Parameters:

bug - the warning

sourceLine - the source location

accumulateBug

public void accumulateBug(BugInstance bug,
 BytecodeScanningDetector visitor)

Accumulate a warning at source location currently being visited by given BytecodeScanningDetector.

Parameters:

bug - the warning

visitor - the BytecodeScanningDetector

uniqueBugs

public Iterable<? extends BugInstance> uniqueBugs()

locations

public Iterable<? extends SourceLineAnnotation> locations(BugInstance bug)

reportAccumulatedBugs

public void reportAccumulatedBugs()

Report accumulated warnings to the BugReporter. Clears all accumulated warnings as a side-effect.

reportBug

public void reportBug(BugInstance bug,
 BugAccumulator.Data d)

clearBugs

public void clearBugs()

Clear all accumulated bugs without reporting them

accumulateBug

public void accumulateBug(BugInstance bug,
 ClassContext classContext,
 org.apache.bcel.classfile.Method method,
 Location location)

accumulateBug

public void accumulateBug(BugInstance bug,
 ClassContext classContext,
 org.apache.bcel.generic.MethodGen methodGen,
 String sourceFile,
 Location location)