Class OperatorWrapCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the policy on how to wrap lines on operators.
-
Property
option
- Specify policy on how to wrap lines. Type iscom.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption
. Default value isnl
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. 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
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.void
Setter to specify policy on how to wrap lines.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_LINE_NEW
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
-
Constructor Details
-
OperatorWrapCheck
public OperatorWrapCheck()
-
-
Method Details
-
setOption
Setter to specify policy on how to wrap lines.- Parameters:
optionStr
- string to decode option from- Throws:
IllegalArgumentException
- if unable to decode
-
getDefaultTokens
public int[] getDefaultTokens()Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
getAcceptableTokens
public int[] getAcceptableTokens()Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-