com.puppycrawl.tools.checkstyle.checks.indentation

Class CommentsIndentationCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.indentation.CommentsIndentationCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class CommentsIndentationCheck
extends Check

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"/module>
 
 
 /*
  * 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 = "";
 
 

Author:

Aleksey Nesterenko, Andrei Selkin

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY_BLOCK A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_KEY_SINGLE A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
CommentsIndentationCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
boolean	isCommentNodesRequired() Whether comment nodes are required or not.
void	visitToken(DetailAST commentAst) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

isCommentNodesRequired

public boolean isCommentNodesRequired()

Description copied from class: Check

Whether comment nodes are required or not.

Overrides:

isCommentNodesRequired in class Check

Returns:

false as a default value.

visitToken

public void visitToken(DetailAST commentAst)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

commentAst - the token to process