com.puppycrawl.tools.checkstyle.checks.sizes

Class ExecutableStatementCountCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class ExecutableStatementCountCheck
extends AbstractCheck

Restricts the number of executable statements to a specified limit.

• Property max - Specify the maximum threshold allowed. Type is int. Default value is 30.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: CTOR_DEF, METHOD_DEF, INSTANCE_INIT, STATIC_INIT, COMPACT_CTOR_DEF, LAMBDA.

To configure the check:

 <module name="ExecutableStatementCount"/>
 

To configure the check with a threshold of 20 for constructor and method definitions:

 <module name="ExecutableStatementCount">
   <property name="max" value="20"/>
   <property name="tokens" value="CTOR_DEF,METHOD_DEF"/>
 </module>
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• executableStatementCount

Since:

3.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ExecutableStatementCountCheck.Context Class to encapsulate counting information about one member.

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
private ExecutableStatementCountCheck.Context	context Current method context.
private java.util.Deque<ExecutableStatementCountCheck.Context>	contextStack Stack of method contexts.
private static int	DEFAULT_MAX Default threshold.
private int	max Specify the maximum threshold allowed.
static java.lang.String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
ExecutableStatementCountCheck() Constructs a ExecutableStatementCountCheck.

Method Summary

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.
private static boolean	isContainerNode(DetailAST node) Check if the node is of type ctor (compact or canonical), instance/ static initializer, method definition or lambda.
private void	leaveContainerNode(DetailAST ast) Process the end of a container node.
void	leaveToken(DetailAST ast) Called after all the child nodes have been process.
void	setMax(int max) Setter to specify the maximum threshold allowed.
private void	visitContainerNode(DetailAST ast) Process the start of the container node.
private void	visitSlist(DetailAST ast) Process the end of a statement list.
void	visitToken(DetailAST ast) Called to process a token.

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

clearViolations, destroy, finishTree, getFileContents, 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.api.AutomaticBean

configure, contextualize, 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 java.lang.String MSG_KEY

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

See Also:

Constant Field Values

DEFAULT_MAX

private static final int DEFAULT_MAX

Default threshold.

See Also:

Constant Field Values

contextStack

private final java.util.Deque<ExecutableStatementCountCheck.Context> contextStack

Stack of method contexts.

max

private int max

Specify the maximum threshold allowed.

context

private ExecutableStatementCountCheck.Context context

Current method context.

Constructor Detail

ExecutableStatementCountCheck

public ExecutableStatementCountCheck()

Constructs a ExecutableStatementCountCheck.

Method Detail

getDefaultTokens

public int[] 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 class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getAcceptableTokens

public int[] 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 class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

setMax

public void setMax(int max)

Setter to specify the maximum threshold allowed.

Parameters:

max - the maximum threshold.

beginTree

public void beginTree(DetailAST rootAST)

Description copied from class: AbstractCheck

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 AbstractCheck

Parameters:

rootAST - the root of the tree

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

leaveToken

public void leaveToken(DetailAST ast)

Description copied from class: AbstractCheck

Called after all the child nodes have been process.

Overrides:

leaveToken in class AbstractCheck

Parameters:

ast - the token leaving

visitContainerNode

private void visitContainerNode(DetailAST ast)

Process the start of the container node.

Parameters:

ast - the token representing the container node.

leaveContainerNode

private void leaveContainerNode(DetailAST ast)

Process the end of a container node.

Parameters:

ast - the token representing the container node.

visitSlist

private void visitSlist(DetailAST ast)

Process the end of a statement list.

Parameters:

ast - the token representing the statement list.

isContainerNode

private static boolean isContainerNode(DetailAST node)

Check if the node is of type ctor (compact or canonical), instance/ static initializer, method definition or lambda.

Parameters:

node - AST node we are checking

Returns:

true if node is of the given types