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

Class AvoidInlineConditionalsCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class AvoidInlineConditionalsCheck
extends AbstractCheck

    Detects inline conditionals. Here is one example of an inline conditional: 

     String a = getParameter("a");
 String b = (a==null || a.length()<1) ? null : a.substring(1);

    Rationale: Some developers find inline conditionals hard to read, so their employer's coding standards forbid them.

    To configure the check: 

     <module name="AvoidInlineConditionals"/>

    Example:

     int x = 5;
 boolean foobar = (x == 5); // OK

 String text;
 text = (text == null) ? "" : text; // violation

 String b;
 if (a != null && a.length() >= 1) { // OK
   b = a.substring(1);
 } else {
   b = null;
 }

 b = (a != null && a.length() >= 1) ? a.substring(1) : null; // violation

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • inline.conditional.avoid
    Since:
    3.1

    • 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

      • AvoidInlineConditionalsCheck

        public AvoidInlineConditionalsCheck()

    • Method Detail

      • 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

      • 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