Package com.puppycrawl.tools.checkstyle.checks.coding

Class 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 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

    • Constructor Detail

      • SimplifyBooleanReturnCheck

        public SimplifyBooleanReturnCheck()

    • 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 class AbstractCheck
        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 class AbstractCheck
        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 class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes

      • 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