Class ClassWarningSuppressor

java.lang.Object

edu.umd.cs.findbugs.WarningSuppressor

edu.umd.cs.findbugs.ClassWarningSuppressor

All Implemented Interfaces:

Matcher

Direct Known Subclasses:

FieldWarningSuppressor, MethodWarningSuppressor, ParameterWarningSuppressor

public class ClassWarningSuppressor
extends WarningSuppressor

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BUG_TYPE
(package private) ClassAnnotation	clazz
private final boolean	userGeneratedClass	Indicates whether this class was "user generated" as defined in MemberUtils.isUserGenerated(edu.umd.cs.findbugs.ba.XClass) When a class is not user generated we are not interested in reporting warnings, in particular we do not want to report US_USELESS_SUPPRESSION_ON_CLASS

Fields inherited from class WarningSuppressor

bugPattern, DEBUG, matchType, PRIORITY, USELESS_SUPPRESSION_ABB

Constructor Summary

Constructors

Constructor	Description
ClassWarningSuppressor(String bugPattern, SuppressMatchType matchType, ClassAnnotation clazz, boolean userGeneratedClass)

Method Summary

Modifier and Type	Method	Description
BugInstance	buildUselessSuppressionBugInstance(UselessSuppressionDetector detector)
ClassAnnotation	getClassAnnotation()
boolean	isUselessSuppressionReportable()
boolean	match(BugInstance bugInstance)	Determine whether or not the given BugInstance has the feature this Matcher tests for.

Methods inherited from class WarningSuppressor

addAlternateSuppressors, adjustBugPatternForMessage, getAlternateSuppressors, writeXML

Methods inherited from class Object

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

Field Details

BUG_TYPE

private static final String BUG_TYPE

See Also:

• Constant Field Values

clazz

ClassAnnotation clazz

userGeneratedClass

private final boolean userGeneratedClass

Indicates whether this class was "user generated" as defined in MemberUtils.isUserGenerated(edu.umd.cs.findbugs.ba.XClass) When a class is not user generated we are not interested in reporting warnings, in particular we do not want to report US_USELESS_SUPPRESSION_ON_CLASS

Constructor Details

ClassWarningSuppressor

public ClassWarningSuppressor(String bugPattern,
 SuppressMatchType matchType,
 ClassAnnotation clazz,
 boolean userGeneratedClass)

Parameters:

userGeneratedClass -

Method Details

getClassAnnotation

public ClassAnnotation getClassAnnotation()

buildUselessSuppressionBugInstance

public BugInstance buildUselessSuppressionBugInstance(UselessSuppressionDetector detector)

Specified by:

buildUselessSuppressionBugInstance in class WarningSuppressor

match

public boolean match(BugInstance bugInstance)

Description copied from interface: Matcher

Determine whether or not the given BugInstance has the feature this Matcher tests for.

Specified by:

match in interface Matcher

Overrides:

match in class WarningSuppressor

Parameters:

bugInstance - the BugInstance

Returns:

true if the BugInstance matches, false if not

isUselessSuppressionReportable

public boolean isUselessSuppressionReportable()

Overrides:

isUselessSuppressionReportable in class WarningSuppressor

Returns:

true if useless suppressions should be reported.