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.AbstractCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class SeparatorWrapCheck
extends AbstractCheck

Checks line wrapping with separators.

• Property option - Specify policy on how to wrap lines. Default value is eol.
• Property tokens - tokens to check Default value is: DOT, COMMA.

Code example for comma and dot at the new line:

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

To configure the check:

 <module name="SeparatorWrap"/>
 

Code example for comma and dot at the previous line:

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

Example for checking method reference at new line (good case and bad case):

 Arrays.sort(stringArray, String:: // violation
     compareToIgnoreCase);
 Arrays.sort(stringArray, String
     ::compareToIgnoreCase); // good
 

To configure the check for METHOD_REF at new line:

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

To configure the check for comma at the new line:

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

Since:

5.8

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_LINE_NEW A key is pointing to the warning message text in "messages.properties" file.
static java.lang.String	MSG_LINE_PREVIOUS A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
SeparatorWrapCheck()

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.
void	setOption(java.lang.String optionStr) Setter to specify policy on how to wrap lines.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

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

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

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_LINE_PREVIOUS

public static final java.lang.String MSG_LINE_PREVIOUS

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_LINE_NEW

public static final java.lang.String MSG_LINE_NEW

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

SeparatorWrapCheck

public SeparatorWrapCheck()

Method Detail

setOption

public void setOption(java.lang.String optionStr)

Setter to specify policy on how to wrap lines.

Parameters:

optionStr - string to decode option from

Throws:

java.lang.IllegalArgumentException - if unable to decode

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process