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

Class MissingDeprecatedCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public final class MissingDeprecatedCheck
extends AbstractJavadocCheck

    Verifies that the annotation @Deprecated and the Javadoc tag @deprecated are both present when either of them is present.

    Both ways of flagging deprecation serve their own purpose. The @Deprecated annotation is used for compilers and development tools. The @deprecated javadoc tag is used to document why something is deprecated and what, if any, alternatives exist.

    In order to properly mark something as deprecated both forms of deprecation should be present.

    Package deprecation is a exception to the rule of always using the javadoc tag and annotation to deprecate. It is not clear if the javadoc tool will support it or not as newer versions keep flip flopping on if it is supported or will cause an error. See JDK-8160601. The deprecated javadoc tag is currently the only way to say why the package is deprecated and what to use instead. Until this is resolved, if you don't want to print violations on package-info, you can use a filter to ignore these files until the javadoc tool faithfully supports it. An example config using SuppressionSingleFilter is: 

     <!-- required till https://bugs.openjdk.java.net/browse/JDK-8160601 -->
 <module name="SuppressionSingleFilter">
     <property name="checks" value="MissingDeprecatedCheck"/>
     <property name="files" value="package-info\.java"/>
 </module>
    • Property violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type is boolean. Default value is false.

    To configure the check: 

     <module name="MissingDeprecated"/>

    Examples of validating source code: 

     @Deprecated
 public static final int MY_CONST = 123456; // no violation

 /** This javadoc is missing deprecated tag. */
 @Deprecated
 public static final int COUNTER = 10; // violation

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • annotation.missing.deprecated
    • javadoc.duplicateTag
    • javadoc.missed.html.close
    • javadoc.parse.rule.error
    • javadoc.wrong.singleton.html.tag
    Since:
    5.0

    • Field Detail

      • MSG_KEY_ANNOTATION_MISSING_DEPRECATED

        public static final java.lang.String MSG_KEY_ANNOTATION_MISSING_DEPRECATED
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

      • MSG_KEY_JAVADOC_DUPLICATE_TAG

        public static final java.lang.String MSG_KEY_JAVADOC_DUPLICATE_TAG
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • MissingDeprecatedCheck

        public MissingDeprecatedCheck()