com.puppycrawl.tools.checkstyle.checks.whitespace

Class OperatorWrapCheck

public class OperatorWrapCheck extends AbstractOptionCheck

Checks line wrapping for operators. The policy to verify is specified using the {@link OperatorWrapOption} class and defaults to {@link OperatorWrapOption#NL}.

By default the check will check the following operators: {@link TokenTypes#BAND BAND}, {@link TokenTypes#BOR BOR}, {@link TokenTypes#BSR BSR}, {@link TokenTypes#BXOR BXOR}, {@link TokenTypes#COLON COLON}, {@link TokenTypes#DIV DIV}, {@link TokenTypes#EQUAL EQUAL}, {@link TokenTypes#GE GE}, {@link TokenTypes#GT GT}, {@link TokenTypes#LAND LAND}, {@link TokenTypes#LE LE}, {@link TokenTypes#LITERAL_INSTANCEOF LITERAL_INSTANCEOF}, {@link TokenTypes#LOR LOR}, {@link TokenTypes#LT LT}, {@link TokenTypes#MINUS MINUS}, {@link TokenTypes#MOD MOD}, {@link TokenTypes#NOT_EQUAL NOT_EQUAL}, {@link TokenTypes#PLUS PLUS}, {@link TokenTypes#QUESTION QUESTION}, {@link TokenTypes#SL SL}, {@link TokenTypes#SR SR}, {@link TokenTypes#STAR STAR}. Other acceptable tokens are {@link TokenTypes#ASSIGN ASSIGN}, {@link TokenTypes#BAND_ASSIGN BAND_ASSIGN}, {@link TokenTypes#BOR_ASSIGN BOR_ASSIGN}, {@link TokenTypes#BSR_ASSIGN BSR_ASSIGN}, {@link TokenTypes#BXOR_ASSIGN BXOR_ASSIGN}, {@link TokenTypes#DIV_ASSIGN DIV_ASSIGN}, {@link TokenTypes#MINUS_ASSIGN MINUS_ASSIGN}, {@link TokenTypes#MOD_ASSIGN MOD_ASSIGN}, {@link TokenTypes#PLUS_ASSIGN PLUS_ASSIGN}, {@link TokenTypes#SL_ASSIGN SL_ASSIGN}, {@link TokenTypes#SR_ASSIGN SR_ASSIGN}, {@link TokenTypes#STAR_ASSIGN STAR_ASSIGN}.

An example of how to configure the check is:

 <module name="OperatorWrap"/>
 

An example of how to configure the check for assignment operators at the end of a line is:

 <module name="OperatorWrap">
     <property name="tokens"
               value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/>
     <property name="option" value="eol"/>
 </module>
 

Version: 1.0

Author: Rick Giles

Constructor Summary
OperatorWrapCheck()
Sets the operator wrap option to new line.
Method Summary
int[]getAcceptableTokens()
{@inheritDoc}
int[]getDefaultTokens()
{@inheritDoc}
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Constructor Detail

OperatorWrapCheck

public OperatorWrapCheck()
Sets the operator wrap option to new line.

Method Detail

getAcceptableTokens

public int[] getAcceptableTokens()
{@inheritDoc}

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc}