NestedTryDepthCheck (checkstyle 6.15 API)

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

All Implemented Interfaces:

Configurable, Contextualizable
```
public final class NestedTryDepthCheck
extends Check
```
Restricts nested try-catch-finally blocks to a specified depth (default = 1).

Author:

Simon Harris

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.

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

NestedTryDepthCheck()

Constructors
Constructor and Description
`NestedTryDepthCheck()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beginTree(DetailAST rootAST)` Called before the starting to process a tree.
`int[]`	`getAcceptableTokens()` The configurable token set.
`int[]`	`getDefaultTokens()` Returns the default token a check is interested in.
`int[]`	`getRequiredTokens()` The tokens that this check must be registered for.
`void`	`leaveToken(DetailAST literalTry)` Called after all the child nodes have been process.
`void`	`setMax(int max)` Setter for maximum allowed nesting depth.
`void`	`visitToken(DetailAST literalTry)` Called to process a token.

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
  - NestedTryDepthCheck
```
public NestedTryDepthCheck()
```
- Method Detail
  - setMax
```
public void setMax(int max)
```
    Setter for maximum allowed nesting depth.
    
    Parameters:
    max - maximum allowed nesting depth.
  - 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
  - getRequiredTokens
```
public 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 initialize information that is to be collected whilst processing a tree.
    
    Overrides:
    
    beginTree in class Check
    
    Parameters:
    rootAST - the root of the tree
  - visitToken
```
public void visitToken(DetailAST literalTry)
```
    Description copied from class: Check
    
    Called to process a token.
    
    Overrides:
    
    visitToken in class Check
    
    Parameters:
    literalTry - the token to process
  - leaveToken
```
public void leaveToken(DetailAST literalTry)
```
    Description copied from class: Check
    
    Called after all the child nodes have been process.
    
    Overrides:
    
    leaveToken in class Check
    
    Parameters:
    literalTry - the token leaving

Class NestedTryDepthCheck

Field Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

MSG_KEY

Constructor Detail

NestedTryDepthCheck

Method Detail

setMax

getDefaultTokens

getAcceptableTokens

getRequiredTokens

beginTree

visitToken

leaveToken