public class NoLineWrapCheck extends AbstractCheck
Checks that chosen statements are not line-wrapped. By default this Check restricts wrapping import and package statements, but it's possible to check any statement.
tokens - tokens to check
Type is int[].
Default value is:
PACKAGE_DEF,
IMPORT,
STATIC_IMPORT.
Examples of line-wrapped statements (bad case):
package com.puppycrawl. // violation
tools.checkstyle.checks;
import com.puppycrawl.tools. // violation
checkstyle.api.AbstractCheck;
import static java.math. // violation
BigInteger.ZERO;
To configure the check to force no line-wrapping in package and import statements (default values):
<module name="NoLineWrap"/>
Examples:
package com.puppycrawl.tools.checkstyle. // violation checks.whitespace; import java.lang.Object; // OK import java.lang. // violation Integer; import static java.math. // violation BigInteger.TEN;
package com.puppycrawl.tools.checkstyle.checks.coding; // OK import java.lang. // violation Boolean; import static java.math.BigInteger.ONE; // OK
To configure the check to force no line-wrapping only in import statements:
<module name="NoLineWrap"> <property name="tokens" value="IMPORT"/> </module>
Example:
package com.puppycrawl. // OK tools.checkstyle.checks; import java.io.*; // OK import java.lang. // violation Boolean; import static java.math. // OK BigInteger.ZERO;
To configure the check to force no line-wrapping only in class, method and constructor definitions:
<module name="NoLineWrap"> <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF"/> </module>
Example:
public class // violation, class definition not wrapped in a single line
Foo {
public Foo() { // OK
}
public static void // violation, method definition not wrapped in a single line
doSomething() {
}
}
public class Bar { // OK
public // violation, constructor definition not wrapped in a single line
Bar() {
}
public int fun() { // OK
}
}
Examples of not line-wrapped statements (good case):
import com.puppycrawl.tools.checkstyle.api.AbstractCheck; import static java.math.BigInteger.ZERO;
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
no.line.wrap
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
NoLineWrapCheck() |
| 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.
|
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_KEY
public NoLineWrapCheck()
public 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.