Class TodoCommentCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class TodoCommentCheck
    extends AbstractCheck

    A check for 'TODO:' comments. To check for other patterns in Java comments, set property format.

    An example of how to configure the check is:

     <module name="TodoComment"/>
     

    An example of how to configure the check for comments that contain TODO or FIXMEis:

     <module name="TodoComment">
        <property name="format" value="(TODO)|(FIXME)"/>
     </module>
     
    • Field Detail

      • MSG_KEY

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

        private java.util.regex.Pattern format
        Regular expression pattern compiled from format.
    • Constructor Detail

      • TodoCommentCheck

        public TodoCommentCheck()
    • Method Detail

      • isCommentNodesRequired

        public boolean isCommentNodesRequired()
        Description copied from class: AbstractCheck
        Whether comment nodes are required or not.
        Overrides:
        isCommentNodesRequired in class AbstractCheck
        Returns:
        false as a default value.
      • setFormat

        public void setFormat​(java.util.regex.Pattern pattern)
        Setter for 'todo' comment pattern.
        Parameters:
        pattern - pattern of 'todo' comment.
      • 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