public class SeparatorWrapCheck extends Check
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 |
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 |
|---|
SeparatorWrapCheck() |
| 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)
Set the option to enforce.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic static final String MSG_LINE_PREVIOUS
public static final String MSG_LINE_NEW
public void setOption(String optionStr)
optionStr - string to decode option fromorg.apache.commons.beanutils.ConversionException - if unable to decodepublic int[] getDefaultTokens()
CheckgetDefaultTokens in class CheckTokenTypespublic int[] getAcceptableTokens()
CheckgetAcceptableTokens in class CheckTokenTypespublic int[] getRequiredTokens()
CheckgetRequiredTokens in class CheckTokenTypespublic void visitToken(DetailAST ast)
CheckvisitToken in class Checkast - the token to processCopyright © 2001–2016. All rights reserved.