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
.
TYPE_EXTENSION_AND
.
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" />
Also, this check can be configured to ignore the colon in an enhanced for loop. The colon in an enhanced for loop is ignored by default
To configure the check to ignore the colon
<property name="ignoreEnhancedForColon" value="true" />
Constructor and Description |
---|
WhitespaceAroundCheck() |
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setAllowEmptyConstructors(boolean aAllow)
Sets whether or not empty constructor bodies are allowed.
|
void |
setAllowEmptyMethods(boolean aAllow)
Sets whether or not empty method bodies are allowed.
|
void |
setIgnoreEnhancedForColon(boolean aIgnore)
Sets whether or not to ignore the whitespace around the
colon in an enhanced for loop.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void setAllowEmptyMethods(boolean aAllow)
aAllow
- true
to allow empty method bodies.public void setAllowEmptyConstructors(boolean aAllow)
aAllow
- true
to allow empty constructor bodies.public void setIgnoreEnhancedForColon(boolean aIgnore)
aIgnore
- true
to ignore enhanced for colon.public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to processCopyright © 2001-2015. All Rights Reserved.