public class SeparatorWrapCheck extends AbstractOptionCheck<WrapOption>
Checks line wrapping with separators.
The policy to verify is specified using the WrapOption
class
and defaults to WrapOption.EOL
.
By default the check will check the following separators:
DOT
,
COMMA
,
Other acceptable tokens are
SEMI
,
ELLIPSIS
,
AT
,
LPAREN
,
RPAREN
,
ARRAY_DECLARATOR
,
RBRACK
,
Code example for comma and dot at the new line:
s .isEmpty(); foo(i ,s);
An example of how to configure the check is:
<module name="SeparatorWrap"/>
Code example for comma and dot at the previous line:
s. isEmpty(); foo(i, s);
An example of how to configure the check for comma at the new line is:
<module name="SeparatorWrap"> <property name="tokens" value="COMMA"/> <property name="option" value="nl"/> </module>
Modifier and Type | Field and Description |
---|---|
static String |
LINE_NEW
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties"
file.
|
SEMICOLON
Constructor and Description |
---|
SeparatorWrapCheck()
Sets the comma wrap option to end of the line.
|
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 |
visitToken(DetailAST ast)
Called to process a token.
|
getAbstractOption, setOption
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String LINE_PREVIOUS
public static final String LINE_NEW
public SeparatorWrapCheck()
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2015. All rights reserved.