Class NestedIfDepthCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class NestedIfDepthCheck
    extends AbstractCheck
    Restricts nested if-else blocks to a specified depth.
    • Property max - Specify maximum allowed nesting depth. Type is int. Default value is 1.

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • nested.if.depth
    Since:
    3.2
    • Field Detail

      • max

        private int max
        Specify maximum allowed nesting depth.
      • depth

        private int depth
        Current nesting depth.
    • Method Detail

      • setMax

        public void setMax​(int max)
        Setter to specify maximum allowed nesting depth.
        Parameters:
        max - maximum allowed nesting depth.
        Since:
        3.2
      • 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
      • isElseIf

        private static boolean isElseIf​(DetailAST ast)
        Returns whether a token represents an ELSE as part of an ELSE / IF set.
        Parameters:
        ast - the token to check
        Returns:
        whether it is
      • isElse

        private static boolean isElse​(DetailAST ast)
        Returns whether a token represents an ELSE.
        Parameters:
        ast - the token to check
        Returns:
        whether the token represents an ELSE
      • isElseWithCurlyBraces

        private static boolean isElseWithCurlyBraces​(DetailAST ast)
        Returns whether a token represents an SLIST as part of an ELSE statement.
        Parameters:
        ast - the token to check
        Returns:
        whether the toke does represent an SLIST as part of an ELSE