com.puppycrawl.tools.checkstyle.checks.whitespace

Class SeparatorWrapCheck

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.AbstractOptionCheck<WrapOption>

com.puppycrawl.tools.checkstyle.checks.whitespace.SeparatorWrapCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class SeparatorWrapCheck
extends AbstractOptionCheck<WrapOption>

Checks line wrapping with separators. The policy to verify is specified using the WrapOption class and defaults to WrapOption.EOL.

By default the check will check the following separators: DOT, COMMA, Other acceptable tokens are SEMI, ELLIPSIS, AT, LPAREN, RPAREN, ARRAY_DECLARATOR, RBRACK,

Code example for comma and dot at the new line:

 s
    .isEmpty();
 foo(i
    ,s);
 

An example of how to configure the check is:

 <module name="SeparatorWrap"/>
 

Code example for comma and dot at the previous line:

 s.
    isEmpty();
 foo(i,
    s);
 

An example of how to configure the check for comma at the new line is:

 <module name="SeparatorWrap">
     <property name="tokens" value="COMMA"/>
     <property name="option" value="nl"/>
 </module>
 

Author:

maxvetrenko

Constructor Summary

Constructors

Constructor and Description
SeparatorWrapCheck() Sets the comma wrap option to end of the line.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck

getAbstractOption, setOption

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

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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

Constructor Detail

SeparatorWrapCheck

public SeparatorWrapCheck()

Sets the comma wrap option to end of the line.

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process