public class SeparatorWrapCheck extends AbstractCheck
Checks line wrapping with separators.
option - Specify policy on how to wrap lines.
Type is com.puppycrawl.tools.checkstyle.checks.whitespace.WrapOption.
Default value is eol.
tokens - tokens to check
Type is int[].
Default value is:
DOT,
COMMA.
To configure the check:
<module name="SeparatorWrap"/>
Example:
import java.io.
IOException; // OK
class Test {
String s;
public void foo(int a,
int b) { // OK
}
public void bar(int p
, int q) { // violation, separator comma on new line
if (s
.isEmpty()) { // violation, separator dot on new line
}
}
}
To configure the check for METHOD_REF at new line:
<module name="SeparatorWrap"> <property name="tokens" value="METHOD_REF"/> <property name="option" value="nl"/> </module>
Example:
import java.util.Arrays;
class Test2 {
String[] stringArray = {"foo", "bar"};
void fun() {
Arrays.sort(stringArray, String::
compareToIgnoreCase); // violation, separator method reference on same line
Arrays.sort(stringArray, String
::compareTo); // OK
}
}
To configure the check for comma at the new line:
<module name="SeparatorWrap"> <property name="tokens" value="COMMA"/> <property name="option" value="nl"/> </module>
Example:
class Test3 {
String s;
int a,
b; // violation, separator comma on same line
public void foo(int a,
int b) { // violation, separator comma on the same line
int r
, t; // OK
}
public void bar(int p
, int q) { // OK
}
}
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 |
|---|
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)
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_PREVIOUS
public static final String MSG_LINE_NEW
public SeparatorWrapCheck()
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.