Class PackageWarningSuppressor

java.lang.Object

edu.umd.cs.findbugs.WarningSuppressor

edu.umd.cs.findbugs.PackageWarningSuppressor

All Implemented Interfaces:

Matcher

public class PackageWarningSuppressor
extends WarningSuppressor

Field Summary

Fields

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

Fields inherited from class WarningSuppressor

bugPattern, DEBUG, matchType, PRIORITY, USELESS_SUPPRESSION_ABB

Constructor Summary

Constructors

Constructor	Description
PackageWarningSuppressor(String bugPattern, SuppressMatchType matchType, String packageName, boolean userGeneratedPackage)

Method Summary

Modifier and Type	Method	Description
BugInstance	buildUselessSuppressionBugInstance(UselessSuppressionDetector detector)
String	getPackageName()
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

packageName

String packageName

userGeneratedPackage

private final boolean userGeneratedPackage

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

Constructor Details

PackageWarningSuppressor

public PackageWarningSuppressor(String bugPattern,
 SuppressMatchType matchType,
 String packageName,
 boolean userGeneratedPackage)

Method Details

getPackageName

public String getPackageName()

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

buildUselessSuppressionBugInstance

public BugInstance buildUselessSuppressionBugInstance(UselessSuppressionDetector detector)

Specified by:

buildUselessSuppressionBugInstance in class WarningSuppressor

isUselessSuppressionReportable

public boolean isUselessSuppressionReportable()

Overrides:

isUselessSuppressionReportable in class WarningSuppressor

Returns:

true if useless suppressions should be reported.