com.puppycrawl.tools.checkstyle.checks.coding

Class AbstractNestedDepthCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

NestedForDepthCheck, NestedIfDepthCheck, NestedTryDepthCheck

public abstract class AbstractNestedDepthCheck
extends Check

Abstract class which provides helpers functionality for nested checks.

Author:

Simon Harris

Constructor Summary

Constructors

Constructor and Description
AbstractNestedDepthCheck(int max) Creates new instance of checks.

Method Summary

Methods

Modifier and Type	Method and Description
void	beginTree(DetailAST rootAST) Called before the starting to process a tree.
int	getMax() Getter for maximum allowed nesting depth.
int[]	getRequiredTokens() The tokens that this check must be registered for.
protected void	nestIn(DetailAST ast, String messageId) Increasing current nesting depth.
protected void	nestOut() Decreasing current nesting depth
void	setMax(int max) Setter for maximum allowed nesting depth.

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

destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNestedDepthCheck

public AbstractNestedDepthCheck(int max)

Creates new instance of checks.

Parameters:

max - default allowed nesting depth.

Method Detail

getRequiredTokens

public final int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

beginTree

public void beginTree(DetailAST rootAST)

Description copied from class: Check

Called before the starting to process a tree. Ideal place to initialise information that is to be collected whilst processing a tree.

Overrides:

beginTree in class Check

Parameters:

rootAST - the root of the tree

getMax

public final int getMax()

Getter for maximum allowed nesting depth.

Returns:

maximum allowed nesting depth.

setMax

public final void setMax(int max)

Setter for maximum allowed nesting depth.

Parameters:

max - maximum allowed nesting depth.

nestIn

protected final void nestIn(DetailAST ast,
          String messageId)

Increasing current nesting depth.

Parameters:

ast - note which increases nesting.

messageId - message id for logging error.

nestOut

protected final void nestOut()

Decreasing current nesting depth