Package edu.umd.cs.findbugs.detect

Class CheckExpectedWarnings

java.lang.Object

edu.umd.cs.findbugs.detect.CheckExpectedWarnings

All Implemented Interfaces:

Detector2, FirstPassDetector, NonReportingDetector, Priorities

public class CheckExpectedWarnings
extends java.lang.Object
implements Detector2, NonReportingDetector

Check uses of the ExpectWarning and NoWarning annotations. This is for internal testing of FindBugs (against findbugsTestCases).

Author:

David Hovemeyer

Field Summary

Fields inherited from interface edu.umd.cs.findbugs.Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
CheckExpectedWarnings(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
void	checkAnnotation(java.lang.String bugCode, java.util.Collection<BugInstance> warnings, boolean expectWarnings, int priority, java.lang.Integer rank, java.lang.Integer num, java.lang.Object methodDescriptor, int minPriority, ClassDescriptor cd)
void	finishPass()	This method is called at the end of the analysis pass.
java.lang.String	getDetectorClassName()	Get the name of the detector class.
BugInstance	makeWarning(java.lang.String bugPattern, java.lang.Object descriptor, int priority, ClassDescriptor cd)
void	visitClass(ClassDescriptor classDescriptor)	Visit a class.

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckExpectedWarnings

public CheckExpectedWarnings(BugReporter bugReporter)

Method Detail

visitClass

public void visitClass(ClassDescriptor classDescriptor)
                throws CheckedAnalysisException

Description copied from interface: Detector2

Visit a class.

Specified by:

visitClass in interface Detector2

Parameters:

classDescriptor - descriptor naming the class to visit

Throws:

CheckedAnalysisException - if an exception occurs during analysis

checkAnnotation

public void checkAnnotation(@CheckForNull
                            java.lang.String bugCode,
                            java.util.Collection<BugInstance> warnings,
                            boolean expectWarnings,
                            int priority,
                            java.lang.Integer rank,
                            java.lang.Integer num,
                            java.lang.Object methodDescriptor,
                            int minPriority,
                            ClassDescriptor cd)

makeWarning

public BugInstance makeWarning(java.lang.String bugPattern,
                               java.lang.Object descriptor,
                               int priority,
                               ClassDescriptor cd)

finishPass

public void finishPass()

Description copied from interface: Detector2

This method is called at the end of the analysis pass.

Specified by:

finishPass in interface Detector2

getDetectorClassName

public java.lang.String getDetectorClassName()

Description copied from interface: Detector2

Get the name of the detector class.

Specified by:

getDetectorClassName in interface Detector2

Returns:

the name of the detector class.