Class NoteSuppressedWarnings

java.lang.Object

edu.umd.cs.findbugs.visitclass.BetterVisitor

edu.umd.cs.findbugs.visitclass.PreorderVisitor

edu.umd.cs.findbugs.visitclass.AnnotationVisitor

edu.umd.cs.findbugs.detect.NoteSuppressedWarnings

All Implemented Interfaces:

Detector, FirstPassDetector, NonReportingDetector, Priorities, org.apache.bcel.classfile.Visitor

public class NoteSuppressedWarnings
extends AnnotationVisitor
implements Detector, NonReportingDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	NoteSuppressedWarnings.RecordComponentSuppressors

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	isRecord	For records the header is compiled into fields, accessor methods and a canonical constructor.
private final Set<String>	packages
private final List<NoteSuppressedWarnings.RecordComponentSuppressors>	recordComponents
private final Map<String, NoteSuppressedWarnings.RecordComponentSuppressors>	recordComponentsByName
private final SuppressionMatcher	suppressionMatcher
private boolean	visitingCanonicalRecordConstructor

Fields inherited from interface Priorities

EXP_PRIORITY, HIGH_PRIORITY, IGNORE_PRIORITY, LOW_PRIORITY, NORMAL_PRIORITY

Constructor Summary

Constructors

Constructor	Description
NoteSuppressedWarnings(BugReporter bugReporter)

Method Summary

Modifier and Type	Method	Description
private static boolean	isConstructor(org.apache.bcel.classfile.Method method)
static boolean	isSuppressWarnings(String annotationClass)
void	report()	This method is called after all classes to be visited.
private void	suppressParameterWarning(int parameter, String pattern, SuppressMatchType matchType)
private void	suppressWarning(String pattern, SuppressMatchType matchType)
void	visitAfter(org.apache.bcel.classfile.JavaClass obj)
void	visitAnnotation(String annotationClass, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a class, field or method
void	visitClassContext(ClassContext classContext)	Visit the ClassContext for a class which should be analyzed for instances of bug patterns.
void	visitField(org.apache.bcel.classfile.Field field)
void	visitMethod(org.apache.bcel.classfile.Method method)
void	visitParameterAnnotation(int p, String annotationClass, Map<String, org.apache.bcel.classfile.ElementValue> map, boolean runtimeVisible)	Visit annotation on a method parameter

Methods inherited from class AnnotationVisitor

getAnnotationParameterAsEnum, getAnnotationParameterAsString, getAnnotationParameterAsStringArray, visitAnnotation, visitParameterAnnotation, visitSyntheticParameterAnnotation

Methods inherited from class PreorderVisitor

amVisitingMainMethod, asUnsignedByte, doVisitMethod, getClassDescriptor, getClassName, getCode, getConstantPool, getDottedClassName, getDottedFieldSig, getDottedMethodSig, getDottedSuperclassName, getField, getFieldDescriptor, getFieldIsStatic, getFieldName, getFieldSig, getFullyQualifiedFieldName, getFullyQualifiedMethodName, getMethod, getMethodDescriptor, getMethodName, getMethodSig, getMethodVisitOrder, getNumberArguments, getNumberMethodArguments, getPackageName, getSizeOfSurroundingTryBlock, getSizeOfSurroundingTryBlock, getSourceFile, getStringFromIndex, getSuperclassName, getSurroundingCaughtExceptions, getSurroundingCaughtExceptions, getSurroundingCaughtExceptionTypes, getSurroundingTryBlock, getSurroundingTryBlock, getThisClass, getXClass, getXField, getXMethod, hasInterestingClass, hasInterestingMethod, isVisitMethodsInCallOrder, setupVisitorForClass, setVisitMethodsInCallOrder, shouldVisit, toString, visitAfter, visitAnnotationDefault, visitAnnotationEntry, visitBootstrapMethods, visitCode, visitConstantInvokeDynamic, visitConstantMethodHandle, visitConstantMethodType, visitConstantModule, visitConstantPackage, visitConstantPool, visitEnclosingMethod, visitingField, visitingMethod, visitInnerClasses, visitJavaClass, visitLineNumberTable, visitLocalVariableTable, visitMethodParameters, visitParameterAnnotationEntry, visitStackMap, visitStackMapEntry

Methods inherited from class BetterVisitor

clone, report, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitCodeException, visitConstantClass, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantNameAndType, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitInnerClass, visitLineNumber, visitLocalVariable, visitLocalVariableTypeTable, visitSignature, visitSourceFile, visitSynthetic, visitUnknown

Methods inherited from class Object

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

Methods inherited from interface org.apache.bcel.classfile.Visitor

visitConstantDynamic, visitMethodParameter, visitModule, visitModuleExports, visitModuleMainClass, visitModuleOpens, visitModulePackages, visitModuleProvides, visitModuleRequires, visitNestHost, visitNestMembers, visitRecord, visitRecordComponent, visitStackMapType

Field Details

packages

private final Set<String> packages

isRecord

private boolean isRecord

For records the header is compiled into fields, accessor methods and a canonical constructor. A SuppressWarnings annotation in the header is applied to the corresponding field, accessor method and parameter of the canonical constructor. In the end we want to report unnecessary suppressions, however when only one of the three suppressors is matched we do not want to report the two others as unnecessary. We link the suppressors together so we can detect whether at least one of them was matched in SuppressionMatcher.match(edu.umd.cs.findbugs.BugInstance)

visitingCanonicalRecordConstructor

private boolean visitingCanonicalRecordConstructor

recordComponents

private final List<NoteSuppressedWarnings.RecordComponentSuppressors> recordComponents

recordComponentsByName

private final Map<String, NoteSuppressedWarnings.RecordComponentSuppressors> recordComponentsByName

suppressionMatcher

private final SuppressionMatcher suppressionMatcher

Constructor Details

NoteSuppressedWarnings

public NoteSuppressedWarnings(BugReporter bugReporter)

Method Details

visitClassContext

public void visitClassContext(ClassContext classContext)

Description copied from interface: Detector

Visit the ClassContext for a class which should be analyzed for instances of bug patterns.

Specified by:

visitClassContext in interface Detector

Parameters:

classContext - the ClassContext

visitField

public void visitField(org.apache.bcel.classfile.Field field)

Specified by:

visitField in interface org.apache.bcel.classfile.Visitor

Overrides:

visitField in class BetterVisitor

visitMethod

public void visitMethod(org.apache.bcel.classfile.Method method)

Specified by:

visitMethod in interface org.apache.bcel.classfile.Visitor

Overrides:

visitMethod in class BetterVisitor

isConstructor

private static boolean isConstructor(org.apache.bcel.classfile.Method method)

visitAfter

public void visitAfter(org.apache.bcel.classfile.JavaClass obj)

Overrides:

visitAfter in class PreorderVisitor

visitAnnotation

public void visitAnnotation(String annotationClass,
 Map<String, org.apache.bcel.classfile.ElementValue> map,
 boolean runtimeVisible)

Description copied from class: AnnotationVisitor

Visit annotation on a class, field or method

Overrides:

visitAnnotation in class AnnotationVisitor

Parameters:

annotationClass - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

isSuppressWarnings

public static boolean isSuppressWarnings(String annotationClass)

visitParameterAnnotation

public void visitParameterAnnotation(int p,
 String annotationClass,
 Map<String, org.apache.bcel.classfile.ElementValue> map,
 boolean runtimeVisible)

Description copied from class: AnnotationVisitor

Visit annotation on a method parameter

Overrides:

visitParameterAnnotation in class AnnotationVisitor

Parameters:

p - parameter number, starting at zero ("this" parameter is not counted)

annotationClass - class of annotation

map - map from names to values

runtimeVisible - true if annotation is runtime visible

suppressParameterWarning

private void suppressParameterWarning(int parameter,
 String pattern,
 SuppressMatchType matchType)

suppressWarning

private void suppressWarning(String pattern,
 SuppressMatchType matchType)

report

public void report()

Description copied from interface: Detector

This method is called after all classes to be visited. It should be used by any detectors which accumulate information over all visited classes to generate results.

Specified by:

report in interface Detector