Class NestedIfDepthCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Restricts nested if-else blocks to a specified depth.
-
Property
max
- Specify maximum allowed nesting depth. Type isint
. Default value is1
.
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
nested.if.depth
- Since:
- 3.2
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.private static boolean
Returns whether a token represents an ELSE.private static boolean
Returns whether a token represents an ELSE as part of an ELSE / IF set.private static boolean
Returns whether a token represents an SLIST as part of an ELSE statement.void
leaveToken
(DetailAST literalIf) Called after all the child nodes have been process.void
setMax
(int max) Setter to specify maximum allowed nesting depth.void
visitToken
(DetailAST literalIf) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
max
Specify maximum allowed nesting depth. -
depth
Current nesting depth.
-
-
Constructor Details
-
NestedIfDepthCheck
public NestedIfDepthCheck()
-
-
Method Details
-
setMax
Setter to specify maximum allowed nesting depth.- Parameters:
max
- maximum allowed nesting depth.- Since:
- 3.2
-
getDefaultTokens
Description copied from class:AbstractCheck
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
literalIf
- the token to process
-
leaveToken
Description copied from class:AbstractCheck
Called after all the child nodes have been process.- Overrides:
leaveToken
in classAbstractCheck
- Parameters:
literalIf
- the token leaving
-
isElseIf
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
Returns whether a token represents an ELSE.- Parameters:
ast
- the token to check- Returns:
- whether the token represents an ELSE
-
isElseWithCurlyBraces
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
-