|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck<OperatorWrapOption>
com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
public class OperatorWrapCheck
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 Summary | |
|---|---|
OperatorWrapCheck()
Sets the operator wrap option to new line. |
|
| Method Summary | |
|---|---|
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. |
| Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck |
|---|
getAbstractOption, setOption |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
|---|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter |
|---|
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity |
| Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean |
|---|
configure, contextualize, finishLocalSetup, getConfiguration, setupChild |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public OperatorWrapCheck()
| Method Detail |
|---|
public int[] getDefaultTokens()
Check
getDefaultTokens in class CheckTokenTypespublic int[] getAcceptableTokens()
Check
getAcceptableTokens in class CheckTokenTypespublic void visitToken(DetailAST aAST)
Check
visitToken in class CheckaAST - the token to process
|
Back to the Checkstyle Home Page | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||