public abstract class ByteCodePatternDetector extends java.lang.Object implements Detector
ByteCodePattern
EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY
Constructor and Description |
---|
ByteCodePatternDetector() |
Modifier and Type | Method and Description |
---|---|
protected abstract BugReporter |
getBugReporter() |
abstract ByteCodePattern |
getPattern()
Get the ByteCodePattern for this detector.
|
abstract boolean |
prescreen(org.apache.bcel.classfile.Method method,
ClassContext classContext)
Prescreen a method.
|
void |
report()
This method is called after all classes to be visited.
|
abstract void |
reportMatch(ClassContext classContext,
org.apache.bcel.classfile.Method method,
ByteCodePatternMatch match)
Called to report an instance of the ByteCodePattern.
|
void |
visitClassContext(ClassContext classContext)
Visit the ClassContext for a class which should be analyzed for instances
of bug patterns.
|
protected abstract BugReporter getBugReporter()
public void visitClassContext(ClassContext classContext)
Detector
visitClassContext
in interface Detector
classContext
- the ClassContextpublic void report()
Detector
public abstract ByteCodePattern getPattern()
public abstract boolean prescreen(org.apache.bcel.classfile.Method method, ClassContext classContext)
Prescreen a method. It is a valid, but dumb, implementation simply to return true unconditionally. A better implementation is to call ClassContext.getBytecodeSet() to check whether the method actually contains the bytecode instructions that the pattern will look for. The theory is that checking the bytecode set is very fast, while building the MethodGen, CFG, ValueNumberAnalysis, etc. objects required to match ByteCodePatterns is slow, and the bytecode pattern matching algorithm is also not particularly fast.
As a datapoint, prescreening speeds up the BCPDoubleCheck detector by a factor of 5 with no loss of generality and only a dozen or so extra lines of code.
method
- the methodclassContext
- the ClassContext for the methodpublic abstract void reportMatch(ClassContext classContext, org.apache.bcel.classfile.Method method, ByteCodePatternMatch match) throws CFGBuilderException, DataflowAnalysisException
classContext
- the ClassContext for the analyzed classmethod
- the method to instance appears inmatch
- the ByteCodePatternMatch object representing the match of the
ByteCodePattern against actual instructions in the methodCFGBuilderException
DataflowAnalysisException
SpotBugs is licensed under the LGPL.