public class OperatorWrapCheck extends AbstractOptionCheck
Checks line wrapping for operators.
The policy to verify is specified using the OperatorWrapOption
class
and defaults to OperatorWrapOption.NL
.
By default the check will check the following operators:
BAND
,
BOR
,
BSR
,
BXOR
,
COLON
,
DIV
,
EQUAL
,
GE
,
GT
,
LAND
,
LE
,
LITERAL_INSTANCEOF
,
LOR
,
LT
,
MINUS
,
MOD
,
NOT_EQUAL
,
PLUS
,
QUESTION
,
SL
,
SR
,
STAR
.
Other acceptable tokens are
ASSIGN
,
BAND_ASSIGN
,
BOR_ASSIGN
,
BSR_ASSIGN
,
BXOR_ASSIGN
,
DIV_ASSIGN
,
MINUS_ASSIGN
,
MOD_ASSIGN
,
PLUS_ASSIGN
,
SL_ASSIGN
,
SR_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>
Constructor and Description |
---|
OperatorWrapCheck()
Sets the operator wrap option to new line.
|
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 aAST)
Called to process a token.
|
getAbstractOption, setOption
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public OperatorWrapCheck()
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
getAcceptableTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to process