public class OperatorWrapCheck extends AbstractCheck
Checks the policy on how to wrap lines on operators.
option - Specify policy on how to wrap lines.
Type is com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption.
Default value is nl.
tokens - tokens to check
Type is int[].
Default value is:
QUESTION,
COLON,
EQUAL,
NOT_EQUAL,
DIV,
PLUS,
MINUS,
STAR,
MOD,
SR,
BSR,
GE,
GT,
SL,
LE,
LT,
BXOR,
BOR,
LOR,
BAND,
LAND,
TYPE_EXTENSION_AND,
LITERAL_INSTANCEOF.
To configure the check:
<module name="OperatorWrap"/>
Example:
class Test {
public static void main(String[] args) {
String s = "Hello" +
"World"; // violation, '+' should be on new line
if (10 ==
20) { // violation, '==' should be on new line.
// body
}
if (10
==
20) { // ok
// body
}
int c = 10 /
5; // violation, '/' should be on new line.
int d = c
+ 10; // ok
}
}
To configure the check for assignment operators at the end of a line:
<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>
Example:
class Test {
public static void main(String[] args) {
int b
= 10; // violation, '=' should be on previous line
int c =
10; // ok
b
+= 10; // violation, '+=' should be on previous line
b +=
10; // ok
c
*= 10; // violation, '*=' should be on previous line
c *=
10; // ok
c
-= 5; // violation, '-=' should be on previous line
c -=
5; // ok
c
/= 2; // violation, '/=' should be on previous line
c
%= 1; // violation, '%=' should be on previous line
c
>>= 1; // violation, '>>=' should be on previous line
c
>>>= 1; // violation, '>>>=' should be on previous line
}
public void myFunction() {
c
^= 1; // violation, '^=' should be on previous line
c
|= 1; // violation, '|=' should be on previous line
c
&=1 ; // violation, '&=' should be on previous line
c
<<= 1; // violation, '<<=' should be on previous line
}
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
line.new
line.previous
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_LINE_NEW
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
OperatorWrapCheck() |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setOption(String optionStr)
Setter to specify policy on how to wrap lines.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final String MSG_LINE_NEW
public static final String MSG_LINE_PREVIOUS
public OperatorWrapCheck()
public void setOption(String optionStr)
optionStr - string to decode option fromIllegalArgumentException - if unable to decodepublic int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processCopyright © 2001–2020. All rights reserved.