com.puppycrawl.tools.checkstyle.checks.metrics

Class NPathComplexityCheck

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.metrics.AbstractComplexityCheck

com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class NPathComplexityCheck
extends AbstractComplexityCheck

Checks the npath complexity against a specified limit (default = 200). The npath metric computes the number of possible execution paths through a function. Similar to the cyclomatic complexity but also takes into account the nesting of conditional statements and multi-part boolean expressions.

Author:

Simon Harris, o_sukhodolsky

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
NPathComplexityCheck() Creates new instance of the check.

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.
protected String	getMessageID() Gets the message ID to log violations with.
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.metrics.AbstractComplexityCheck

getCurrentValue, getRequiredTokens, incrementCurrentValue, leaveTokenHook, popValue, pushValue, setCurrentValue, setMax, visitTokenHook

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

beginTree, 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

NPathComplexityCheck

public NPathComplexityCheck()

Creates new instance of the check.

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 AbstractComplexityCheck

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 AbstractComplexityCheck

Parameters:

ast - the token leaving

getMessageID

protected String getMessageID()

Description copied from class: AbstractComplexityCheck

Gets the message ID to log violations with.

Specified by:

getMessageID in class AbstractComplexityCheck

Returns:

the message ID to log violations with