Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class WriteTagCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class WriteTagCheck
extends AbstractCheck

    Requires user defined Javadoc tag to be present in Javadoc comment with defined format. To define the format for a tag, set property tagFormat to a regular expression. Property tagSeverity is used for severity of events when the tag exists.

    • Property tag - Specify the name of tag. Type is java.lang.String. Default value is null.
    • Property tagFormat - Specify the regexp to match tag content. Type is java.util.regex.Pattern. Default value is null.
    • Property tagSeverity - Specify the severity level when tag is found and printed. Type is com.puppycrawl.tools.checkstyle.api.SeverityLevel. Default value is info.
    • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: INTERFACE_DEF, CLASS_DEF, ENUM_DEF, ANNOTATION_DEF, RECORD_DEF.

    To configure the check for printing author name: 

     <module name="WriteTag">
   <property name="tag" value="@author"/>
   <property name="tagFormat" value="\S"/>
 </module>

    To configure the check to print warnings if an "@incomplete" tag is found, and not print anything if it is not found: 

     <module name="WriteTag">
   <property name="tag" value="@incomplete"/>
   <property name="tagFormat" value="\S"/>
   <property name="severity" value="ignore"/>
   <property name="tagSeverity" value="warning"/>
 </module>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.writeTag
    • type.missingTag
    • type.tagFormat
    Since:
    4.2

    • Field Detail

      • 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_WRITE_TAG

        public static final java.lang.String MSG_WRITE_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

    • Constructor Detail

      • WriteTagCheck

        public WriteTagCheck()

    • Method Detail

      • setTag

        public void setTag​(java.lang.String tag)
        Setter to specify the name of tag.
        Parameters:
        tag - tag to check

      • setTagFormat

        public void setTagFormat​(java.util.regex.Pattern pattern)
        Setter to specify the regexp to match tag content.
        Parameters:
        pattern - a String value

      • setTagSeverity

        public final void setTagSeverity​(SeverityLevel severity)
        Setter to specify the severity level when tag is found and printed.
        Parameters:
        severity - The new severity level
        See Also:
        SeverityLevel

      • 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