Class JavadocTypeCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocTypeCheck
    extends AbstractCheck
    Checks the Javadoc of a type.

    Does not perform checks for author and version tags for inner classes, as they should be redundant because of outer class.

    • Field Detail

      • MSG_UNKNOWN_TAG

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

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

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

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

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

      • JavadocTypeCheck

        public JavadocTypeCheck()
    • Method Detail

      • setScope

        public void setScope​(Scope scope)
        Sets the scope to check.
        Parameters:
        scope - a scope.
      • setExcludeScope

        public void setExcludeScope​(Scope excludeScope)
        Set the excludeScope.
        Parameters:
        excludeScope - a scope.
      • setAuthorFormat

        public void setAuthorFormat​(java.util.regex.Pattern pattern)
        Set the author tag pattern.
        Parameters:
        pattern - a pattern.
      • setVersionFormat

        public void setVersionFormat​(java.util.regex.Pattern pattern)
        Set the version format pattern.
        Parameters:
        pattern - a pattern.
      • setAllowMissingParamTags

        public void setAllowMissingParamTags​(boolean flag)
        Controls whether to allow a type which has type parameters to omit matching param tags in the javadoc. Defaults to false.
        Parameters:
        flag - a Boolean value
      • setAllowUnknownTags

        public void setAllowUnknownTags​(boolean flag)
        Controls whether to flag violations for unknown tags. Defaults to false.
        Parameters:
        flag - a Boolean value
      • setAllowedAnnotations

        public void setAllowedAnnotations​(java.lang.String... userAnnotations)
        Sets list of annotations.
        Parameters:
        userAnnotations - user's value.
      • 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