public class NeedBracesCheck extends AbstractCheck
Checks for braces around code blocks.
allowSingleLineStatement - allow single-line statements without braces.
Type is boolean.
Default value is false.
allowEmptyLoopBody - allow loops with empty bodies.
Type is boolean.
Default value is false.
tokens - tokens to check
Type is int[].
Default value is:
LITERAL_DO,
LITERAL_ELSE,
LITERAL_FOR,
LITERAL_IF,
LITERAL_WHILE.
To configure the check:
<module name="NeedBraces"/>
To configure the check for if and else blocks:
<module name="NeedBraces"> <property name="tokens" value="LITERAL_IF, LITERAL_ELSE"/> </module>
To configure the check to allow single-line statements
(if, while, do-while, for) without braces:
<module name="NeedBraces"> <property name="allowSingleLineStatement" value="true"/> </module>
Next statements won't be violated by check:
if (obj.isValid()) return true; // OK while (obj.isValid()) return true; // OK do this.notify(); while (o != null); // OK for (int i = 0; ; ) this.notify(); // OK
To configure the check to allow case, default single-line statements without braces:
<module name="NeedBraces"> <property name="tokens" value="LITERAL_CASE, LITERAL_DEFAULT"/> <property name="allowSingleLineStatement" value="true"/> </module>
Next statements won't be violated by check:
switch (num) {
case 1: counter++; break; // OK
case 6: counter += 10; break; // OK
default: counter = 100; break; // OK
}
To configure the check to allow loops (while, for) with empty bodies:
<module name="NeedBraces"> <property name="allowEmptyLoopBody" value="true"/> </module>
Next statements won't be violated by check:
while (value.incrementValue() < 5); // OK for(int i = 0; i < 10; value.incrementValue()); // OK
To configure the check to lambdas:
<module name="NeedBraces"> <property name="tokens" value="LAMBDA"/> <property name="allowSingleLineStatement" value="true"/> </module>
Results in following:
allowedFuture.addCallback(result -> assertEquals("Invalid response",
EnumSet.of(HttpMethod.GET, HttpMethod.OPTIONS), result), // violation, lambda spans 2 lines
ex -> fail(ex.getMessage())); // OK
allowedFuture.addCallback(result -> {
return assertEquals("Invalid response",
EnumSet.of(HttpMethod.GET, HttpMethod.OPTIONS), result);
}, // OK
ex -> fail(ex.getMessage()));
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
needBraces
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_KEY_NEED_BRACES
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
NeedBracesCheck() |
| 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 |
setAllowEmptyLoopBody(boolean allowEmptyLoopBody)
Setter to allow loops with empty bodies.
|
void |
setAllowSingleLineStatement(boolean allowSingleLineStatement)
Setter to allow single-line statements without braces.
|
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_NEED_BRACES
public NeedBracesCheck()
public void setAllowSingleLineStatement(boolean allowSingleLineStatement)
allowSingleLineStatement - Check's option for skipping single-line statementspublic void setAllowEmptyLoopBody(boolean allowEmptyLoopBody)
allowEmptyLoopBody - Check's option for allowing loops with empty body.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.