com.puppycrawl.tools.checkstyle.checks.annotation

Class MissingDeprecatedCheck

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.javadoc.AbstractJavadocCheck

com.puppycrawl.tools.checkstyle.checks.annotation.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

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
static String	MSG_KEY_ANNOTATION_MISSING_DEPRECATED A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_KEY_JAVADOC_DUPLICATE_TAG A key is pointing to the warning message text in "messages.properties" file.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG

Constructor Summary

Constructors

Constructor and Description
MissingDeprecatedCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default javadoc token types a check is interested in.
int[]	getRequiredJavadocTokens() The javadoc tokens that this check must be registered for.
void	visitJavadocToken(DetailNode ast) Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitToken

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

clearMessages, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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_ANNOTATION_MISSING_DEPRECATED

public static final 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 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()

Method Detail

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default javadoc token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default javadoc token types

See Also:

JavadocTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

JavadocTokenTypes

visitJavadocToken

public void visitJavadocToken(DetailNode ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process