com.puppycrawl.tools.checkstyle.checks.coding

Class NestedForDepthCheck

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.NestedForDepthCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class NestedForDepthCheck
extends AbstractNestedDepthCheck

Check the number of nested for -statements. The maximum number of nested layers can be configured. The default value is 1. Most of the logic is implemented in the parent class. The code for the class is copied from the NestedIfDepthCheck-class. The only difference is the intercepted token (for instead of if). Example:

  <!-- Restricts nested for blocks to a specified depth (default = 1).
                                                                        -->
  <module name="com.puppycrawl.tools.checkstyle.checks.coding
                                            .CatchWithLostStackCheck">
    <property name="severity" value="info"/>
    <property name="max" value="1"/>
  </module>
 

Author:

Alexander Jesse

See Also:

AbstractNestedDepthCheck, NestedIfDepthCheck

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

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

Method Summary

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

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

beginTree, getRequiredTokens, nestIn, nestOut, setMax

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

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

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

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

NestedForDepthCheck

public NestedForDepthCheck()

Creates new check instance with default allowed nesting depth.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

leaveToken

public void leaveToken(DetailAST ast)

Description copied from class: Check

Called after all the child nodes have been process.

Overrides:

leaveToken in class Check

Parameters:

ast - the token leaving