com.puppycrawl.tools.checkstyle.checks.metrics

Class CyclomaticComplexityCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class CyclomaticComplexityCheck
extends AbstractComplexityCheck

Checks cyclomatic complexity against a specified limit. The complexity is measured by the number of "if", "while", "do", "for", "?:", "catch", "switch", "case", "&&" and "||" statements (plus one) in the body of the member. It is a measure of the minimum number of possible paths through the source and therefore the number of required tests. Generally 1-4 is considered good, 5-7 ok, 8-10 consider re-factoring, and 11+ re-factor now!

Check has following properties:

switchBlockAsSingleDecisionPoint - controls whether to treat the whole switch block as a single decision point. Default value is false

Author:

Simon Harris, Oliver Burn, Andrei Selkin

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
CyclomaticComplexityCheck() Create an instance.

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	setSwitchBlockAsSingleDecisionPoint(boolean switchBlockAsSingleDecisionPoint) Sets whether to treat the whole switch block as a single decision point.
protected void	visitTokenHook(DetailAST ast) Hook called when visiting a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.metrics.AbstractComplexityCheck

getCurrentValue, getRequiredTokens, incrementCurrentValue, leaveToken, leaveTokenHook, popValue, pushValue, setCurrentValue, setMax, visitToken

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

CyclomaticComplexityCheck

public CyclomaticComplexityCheck()

Create an instance.

Method Detail

setSwitchBlockAsSingleDecisionPoint

public void setSwitchBlockAsSingleDecisionPoint(boolean switchBlockAsSingleDecisionPoint)

Sets whether to treat the whole switch block as a single decision point.

Parameters:

switchBlockAsSingleDecisionPoint - whether to treat the whole switch block as a single decision point.

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

visitTokenHook

protected final void visitTokenHook(DetailAST ast)

Description copied from class: AbstractComplexityCheck

Hook called when visiting a token. Will not be called the method definition tokens.

Overrides:

visitTokenHook in class AbstractComplexityCheck

Parameters:

ast - the token being visited

getMessageID

protected final 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