Class SimplifyBooleanReturnCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
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"/>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description SimplifyBooleanReturnCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
canReturnOnlyBooleanLiteral
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.Returns
true
iff ast represents
return true/false;
or
{ return true/false; }
- Parameters:
ast
- the syntax tree to check- Returns:
- if ast is a return statement with a boolean literal.
-
isBooleanLiteralReturnStatement
private static boolean isBooleanLiteralReturnStatement(antlr.collections.AST ast)
Returns if an AST is a return statement with a boolean literal.Returns
true
iff ast represents
return true/false;
- Parameters:
ast
- the syntax tree to check- Returns:
- if ast is a return statement with a boolean literal.
-
isBooleanLiteralType
private static boolean isBooleanLiteralType(int tokenType)
Checks if a token type is a literal true or false.- Parameters:
tokenType
- the TokenType- Returns:
- true iff tokenType is LITERAL_TRUE or LITERAL_FALSE
-
-