Class 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