Package com.puppycrawl.tools.checkstyle.checks.annotation

Class 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.

    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

    • 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

    • 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