com.puppycrawl.tools.checkstyle.checks.annotation

Class SuppressWarningsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class SuppressWarningsCheck
extends AbstractCheck

Allows to specify what warnings that @SuppressWarnings is not allowed to suppress. You can also specify a list of TokenTypes that the configured warning(s) cannot be suppressed on.

Limitations: This check does not consider conditionals inside the @SuppressWarnings annotation.

For example: @SuppressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused"). According to the above example, the "unused" warning is being suppressed not the "unchecked" or "foo" warnings. All of these warnings will be considered and matched against regardless of what the conditional evaluates to. The check also does not support code like @SuppressWarnings("un" + "used"), @SuppressWarnings((String) "unused") or @SuppressWarnings({('u' + (char)'n') + (""+("used" + (String)"")),}).

By default, any warning specified will be disallowed on all legal TokenTypes unless otherwise specified via the tokens property.

Also, by default warnings that are empty strings or all whitespace (regex: ^$|^\s+$) are flagged. By specifying, the format property these defaults no longer apply.

This check can be configured so that the "unchecked" and "unused" warnings cannot be suppressed on anything but variable and parameter declarations. See below of an example.

• Property format - Specify the RegExp to match against warnings. Any warning being suppressed matching this pattern will be flagged. Type is java.util.regex.Pattern. Default value is "^\s*+$".
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF, RECORD_DEF.

To configure the check:

 <module name="SuppressWarnings"/>
 

To configure the check so that the "unchecked" and "unused" warnings cannot be suppressed on anything but variable and parameter declarations.

 <module name="SuppressWarnings">
   <property name="format"
       value="^unchecked$|^unused$"/>
   <property name="tokens"
     value="
     CLASS_DEF,INTERFACE_DEF,ENUM_DEF,
     ANNOTATION_DEF,ANNOTATION_FIELD_DEF,
     ENUM_CONSTANT_DEF,METHOD_DEF,CTOR_DEF
     "/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• suppressed.warning.not.allowed

Since:

5.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.regex.Pattern	format Specify the RegExp to match against warnings.
private static java.lang.String	FQ_SUPPRESS_WARNINGS Fully-qualified SuppressWarnings annotation name.
static java.lang.String	MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED A key is pointing to the warning message text in "messages.properties" file.
private static java.lang.String	SUPPRESS_WARNINGS SuppressWarnings annotation name.

Constructor Summary

Constructors

Constructor and Description
SuppressWarningsCheck()

Method Summary

Modifier and Type	Method and Description
private static DetailAST	findWarningsHolder(DetailAST annotation) Find the parent (holder) of the of the warnings (Expr).
int[]	getAcceptableTokens() The configurable token set.
private static DetailAST	getCondLeft(DetailAST cond) Retrieves the left side of a conditional.
private static DetailAST	getCondRight(DetailAST cond) Retrieves the right side of a conditional.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
private static DetailAST	getSuppressWarnings(DetailAST ast) Gets the SuppressWarnings annotation that is annotating the AST.
private void	logMatch(DetailAST ast, java.lang.String warningText) This method looks for a warning that matches a configured expression.
private static java.lang.String	removeQuotes(java.lang.String warning) Strips a single double quote from the front and back of a string.
void	setFormat(java.util.regex.Pattern pattern) Setter to specify the RegExp to match against warnings.
void	visitToken(DetailAST ast) Called to process a token.
private void	walkConditional(DetailAST cond) Recursively walks a conditional expression checking the left and right sides, checking for matches and logging violations.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED

public static final java.lang.String MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

SUPPRESS_WARNINGS

private static final java.lang.String SUPPRESS_WARNINGS

SuppressWarnings annotation name.

See Also:

Constant Field Values

FQ_SUPPRESS_WARNINGS

private static final java.lang.String FQ_SUPPRESS_WARNINGS

Fully-qualified SuppressWarnings annotation name.

See Also:

Constant Field Values

format

private java.util.regex.Pattern format

Specify the RegExp to match against warnings. Any warning being suppressed matching this pattern will be flagged.

Constructor Detail

SuppressWarningsCheck

public SuppressWarningsCheck()

Method Detail

setFormat

public final void setFormat(java.util.regex.Pattern pattern)

Setter to specify the RegExp to match against warnings. Any warning being suppressed matching this pattern will be flagged.

Parameters:

pattern - the new pattern

getDefaultTokens

public final int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public final int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

getSuppressWarnings

private static DetailAST getSuppressWarnings(DetailAST ast)

Gets the SuppressWarnings annotation that is annotating the AST. If the annotation does not exist this method will return null.

Parameters:

ast - the AST

Returns:

the SuppressWarnings annotation

logMatch

private void logMatch(DetailAST ast,
                      java.lang.String warningText)

This method looks for a warning that matches a configured expression. If found it logs a violation at the given AST.

Parameters:

ast - the location to place the violation

warningText - the warning.

findWarningsHolder

private static DetailAST findWarningsHolder(DetailAST annotation)

Find the parent (holder) of the of the warnings (Expr).

Parameters:

annotation - the annotation

Returns:

a Token representing the expr.

removeQuotes

private static java.lang.String removeQuotes(java.lang.String warning)

Strips a single double quote from the front and back of a string.

For example:

 Input String = "unchecked"
 

Output String = unchecked

Parameters:

warning - the warning string

Returns:

the string without two quotes

walkConditional

private void walkConditional(DetailAST cond)

Recursively walks a conditional expression checking the left and right sides, checking for matches and logging violations.

Parameters:

cond - a Conditional type QUESTION

getCondLeft

private static DetailAST getCondLeft(DetailAST cond)

Retrieves the left side of a conditional.

Parameters:

cond - cond a conditional type QUESTION

Returns:

either the value or another conditional

getCondRight

private static DetailAST getCondRight(DetailAST cond)

Retrieves the right side of a conditional.

Parameters:

cond - a conditional type QUESTION

Returns:

either the value or another conditional