com.puppycrawl.tools.checkstyle.checks.coding

Class NestedIfDepthCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck

com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class NestedIfDepthCheck
extends AbstractNestedDepthCheck

Restricts nested if-else blocks to a specified depth (default = 1).

Author:

Simon Harris

Constructor Summary

Constructors

Constructor and Description
NestedIfDepthCheck() Creates new check instance with default allowed nesting depth.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	leaveToken(DetailAST aAST) Called after all the child nodes have been process.
void	visitToken(DetailAST aAST) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck

beginTree, getMax, getRequiredTokens, nestIn, nestOut, setMax

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NestedIfDepthCheck

public NestedIfDepthCheck()

Creates new check instance with default allowed nesting depth.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

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 Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST aAST)

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

aAST - the token to process

leaveToken

public void leaveToken(DetailAST aAST)

Called after all the child nodes have been process.

Overrides:

leaveToken in class Check

Parameters:

aAST - the token leaving