public class SimplifyBooleanReturnCheck extends AbstractCheck
Checks for overly complicated boolean return statements. Idea shamelessly stolen from the equivalent PMD rule (pmd.sourceforge.net).
An example of how to configure the check is:
<module name="SimplifyBooleanReturn"/>
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
SimplifyBooleanReturnCheck() |
| Modifier and Type | Method and Description |
|---|---|
private static boolean |
canReturnOnlyBooleanLiteral(antlr.collections.AST ast)
Returns if an AST is a return statement with a boolean literal
or a compound statement that contains only such a return statement.
|
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.
|
private static boolean |
isBooleanLiteralReturnStatement(antlr.collections.AST ast)
Returns if an AST is a return statement with a boolean literal.
|
private static boolean |
isBooleanLiteralType(int tokenType)
Checks if a token type is a literal true or false.
|
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 java.lang.String MSG_KEY
public int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processprivate static boolean canReturnOnlyBooleanLiteral(antlr.collections.AST ast)
Returns true iff ast represents
return true/false;or
{
return true/false;
}
ast - the syntax tree to checkprivate static boolean isBooleanLiteralReturnStatement(antlr.collections.AST ast)
Returns true iff ast represents
return true/false;
ast - the syntax tree to checkprivate static boolean isBooleanLiteralType(int tokenType)
tokenType - the TokenType