Class MissingDeprecatedCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class MissingDeprecatedCheck
    extends AbstractCheck

    This class is used to verify that both the Deprecated annotation and the deprecated javadoc tag are present when either one 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. Only the package-info.java file can contain a Deprecated annotation and it CANNOT contain a deprecated javadoc tag. This is the case with Sun's javadoc tool released with JDK 1.6.0_11. As a result, this check does not deal with Deprecated packages in any way. No official documentation was found confirming this behavior is correct (of the javadoc tool).

    To configure this check do the following:

     <module name="JavadocDeprecated"/>
     

    In addition you can configure this check with skipNoJavadoc option to allow it to ignore cases when JavaDoc is missing, but still warns when JavaDoc is present but either Deprecated is missing from JavaDoc or Deprecated is missing from the element. To configure this check to allow it use:

       <property name="skipNoJavadoc" value="true" />

    Examples of validating source code with skipNoJavadoc:

     
     @deprecated
     public static final int MY_CONST = 123456; // no violation
    
     /** This javadoc is missing deprecated tag. */
     @deprecated
     public static final int COUNTER = 10; // violation as javadoc exists
     
     
    • 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
      • MSG_KEY_JAVADOC_MISSING

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

        private static final java.lang.String DEPRECATED
        Deprecated annotation name.
        See Also:
        Constant Field Values
      • FQ_DEPRECATED

        private static final java.lang.String FQ_DEPRECATED
        Fully-qualified Deprecated annotation name.
        See Also:
        Constant Field Values
      • MATCH_DEPRECATED

        private static final java.util.regex.Pattern MATCH_DEPRECATED
        Compiled regexp to match Javadoc tag with no argument.
      • MATCH_DEPRECATED_MULTILINE_START

        private static final java.util.regex.Pattern MATCH_DEPRECATED_MULTILINE_START
        Compiled regexp to match first part of multilineJavadoc tags.
      • MATCH_DEPRECATED_MULTILINE_CONT

        private static final java.util.regex.Pattern MATCH_DEPRECATED_MULTILINE_CONT
        Compiled regexp to look for a continuation of the comment.
      • END_JAVADOC

        private static final java.lang.String END_JAVADOC
        Multiline finished at end of comment.
        See Also:
        Constant Field Values
      • NEXT_TAG

        private static final java.lang.String NEXT_TAG
        Multiline finished at next Javadoc.
        See Also:
        Constant Field Values
      • skipNoJavadoc

        private boolean skipNoJavadoc
        Is deprecated element valid without javadoc.
    • Constructor Detail

      • MissingDeprecatedCheck

        public MissingDeprecatedCheck()
    • Method Detail

      • setSkipNoJavadoc

        public void setSkipNoJavadoc​(boolean skipNoJavadoc)
        Set skipJavadoc value.
        Parameters:
        skipNoJavadoc - user's value of skipJavadoc
      • getDefaultTokens

        public 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 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
      • containsJavadocTag

        private boolean containsJavadocTag​(TextBlock javadoc)
        Checks to see if the text block contains a deprecated tag.
        Parameters:
        javadoc - the javadoc of the AST
        Returns:
        true if contains the tag
      • checkTagAtTheRestOfComment

        private boolean checkTagAtTheRestOfComment​(java.lang.String[] lines,
                                                   boolean foundBefore,
                                                   int currentLine,
                                                   int index)
        Look for the rest of the comment if all we saw was the tag and the name. Stop when we see '*' (end of Javadoc), '@' (start of next tag), or anything that's not whitespace or '*' characters.
        Parameters:
        lines - all lines
        foundBefore - flag from parent method
        currentLine - current line
        index - som index
        Returns:
        true if Tag is found