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
This check allows you 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.The
warnings
property is a regex pattern. Any warning being suppressed matching this pattern will be flagged.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.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)"")),})
.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.
<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>
- Author:
- Travis Schneeberger
-
-
Field Summary
Fields Modifier and Type Field Description static String
MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description SuppressWarningsCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.void
setFormat(Pattern pattern)
Set the format for the specified regular expression.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY_SUPPRESSED_WARNING_NOT_ALLOWED
public static final 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
-
-
Constructor Detail
-
SuppressWarningsCheck
public SuppressWarningsCheck()
-
-
Method Detail
-
setFormat
public final void setFormat(Pattern pattern)
Set the format for the specified regular expression.- 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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Parameters:
ast
- the token to process
-
-