Class CommentsIndentationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class CommentsIndentationCheck
    extends AbstractCheck
    This Check controls the indentation between comments and surrounding code. Comments are indented at the same level as the surrounding code. Detailed info about such convention can be found here

    Examples:

    To configure the Check:

     
     <module name="CommentsIndentation"/>
     
     
     /*
      * comment
      * some comment
      */
     boolean bool = true; - such comment indentation is ok
        /*
        * comment
        * some comment
         */
     double d = 3.14; - Block Comment has incorrect indentation level 7, expected 4.
     // some comment - comment is ok
     String str = "";
         // some comment Comment has incorrect indentation level 8, expected 4.
     String str1 = "";
     
     
    • Field Detail

      • MSG_KEY_SINGLE

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

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

      • CommentsIndentationCheck

        public CommentsIndentationCheck()
    • Method Detail

      • 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
      • 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.
      • visitToken

        public void visitToken​(DetailAST commentAst)
        Description copied from class: AbstractCheck
        Called to process a token.
        Overrides:
        visitToken in class AbstractCheck
        Parameters:
        commentAst - the token to process