public class NeedBracesCheck extends AbstractCheck
Checks for braces around code blocks.
By default the check will check the following blocks:
LITERAL_DO,
LITERAL_ELSE,
LITERAL_FOR,
LITERAL_IF,
LITERAL_WHILE.
An example of how to configure the check is:
<module name="NeedBraces"/>
An example of how to configure the check for if and
else blocks is:
<module name="NeedBraces">
<property name="tokens" value="LITERAL_IF, LITERAL_ELSE"/>
</module>
Check has the following options:
allowSingleLineStatement which allows single-line statements without braces, e.g.:
if (obj.isValid()) return true;
while (obj.isValid()) return true;
do this.notify(); while (o != null);
for (int i = 0; ; ) this.notify();
allowEmptyLoopBody which allows loops with empty bodies, e.g.:
while (value.incrementValue() < 5);
for(int i = 0; i < 10; value.incrementValue());
Default value for allowEmptyLoopBody option is false.
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>
Such statements would be allowed:
switch (num) {
case 1: counter++; break; // OK
case 6: counter += 10; break; // OK
default: counter = 100; break; // OK
}
To configure the Check to allow while, for loops with empty bodies:
<module name="NeedBraces">
<property name="allowEmptyLoopBody" value="true"/>
</module>
Such statements would be allowed:
while (value.incrementValue() < 5); // OK
for(int i = 0; i < 10; value.incrementValue()); // OK
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)
Sets whether to allow empty loop body.
|
void |
setAllowSingleLineStatement(boolean allowSingleLineStatement)
Setter.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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–2018. All rights reserved.