com.puppycrawl.tools.checkstyle.checks.whitespace

Class WhitespaceAroundCheck

public class WhitespaceAroundCheck extends Check

Checks that a token is surrounded by whitespace.

By default the check will check the following operators: ASSERT, ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN. LITERAL_ASSERT. GENERIC_START. GENERIC_END. TYPE_EXTENSION_AND. WILDCARD_TYPE.

An example of how to configure the check is:

 <module name="WhitespaceAround"/>
 

An example of how to configure the check for whitespace only around assignment operators is:

 <module name="WhitespaceAround">
     <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"/>
 </module>
 

In addition, this check can be configured to allow empty method and/or constructor bodies. For example, a method with an empty body might look like:

    public void doSomething(int val) {}

To configure the check to allow empty method blocks use

   <property name="allowEmptyMethods" value="true" />

To configure the check to allow empty constructor blocks use

   <property name="allowEmptyConstructors" value="true" />

Version: 1.0

Author: Oliver Burn

Method Summary
int[]getDefaultTokens()
voidsetAllowEmptyConstructors(boolean aAllow)
Sets whether or now empty constructor bodies are allowed.
voidsetAllowEmptyMethods(boolean aAllow)
Sets whether or now empty method bodies are allowed.
voidvisitToken(DetailAST aAST)

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc }

setAllowEmptyConstructors

public void setAllowEmptyConstructors(boolean aAllow)
Sets whether or now empty constructor bodies are allowed.

Parameters: aAllow true to allow empty constructor bodies.

setAllowEmptyMethods

public void setAllowEmptyMethods(boolean aAllow)
Sets whether or now empty method bodies are allowed.

Parameters: aAllow true to allow empty method bodies.

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc }