com.puppycrawl.tools.checkstyle.checks.metrics

Class AbstractComplexityCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

CyclomaticComplexityCheck, NPathComplexityCheck

public abstract class AbstractComplexityCheck
extends Check

Base class for checks the calculate complexity based around methods.

Author:

Simon Harris, Oliver Burn

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComplexityCheck(int max) Creates an instance.

Method Summary

Modifier and Type	Method and Description
protected BigInteger	getCurrentValue() Gets the current value.
protected abstract String	getMessageID() Gets the message ID to log violations with.
int[]	getRequiredTokens() The tokens that this check must be registered for.
protected void	incrementCurrentValue(BigInteger by) Increments the current value by a specified amount.
void	leaveToken(DetailAST ast) Called after all the child nodes have been process.
protected void	leaveTokenHook(DetailAST ast) Hook called when leaving a token.
protected BigInteger	popValue() Pops a value off the stack and makes it the current value.
protected void	pushValue() Push the current value on the stack.
protected void	setCurrentValue(BigInteger value) Set the current value.
void	setMax(int max) Set the maximum threshold allowed.
void	visitToken(DetailAST ast) Called to process a token.
protected void	visitTokenHook(DetailAST ast) Hook called when visiting a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, 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

Constructor Detail

AbstractComplexityCheck

protected AbstractComplexityCheck(int max)

Creates an instance.

Parameters:

max - the threshold of when to report an error

Method Detail

getMessageID

protected abstract String getMessageID()

Gets the message ID to log violations with.

Returns:

the message ID to log violations with

getRequiredTokens

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

setMax

public final void setMax(int max)

Set the maximum threshold allowed.

Parameters:

max - the maximum threshold

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

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 Check

Parameters:

ast - the token leaving

visitTokenHook

protected void visitTokenHook(DetailAST ast)

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

Parameters:

ast - the token being visited

leaveTokenHook

protected void leaveTokenHook(DetailAST ast)

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

Parameters:

ast - the token being left

getCurrentValue

protected final BigInteger getCurrentValue()

Gets the current value.

Returns:

the current value

setCurrentValue

protected final void setCurrentValue(BigInteger value)

Set the current value.

Parameters:

value - the new value

incrementCurrentValue

protected final void incrementCurrentValue(BigInteger by)

Increments the current value by a specified amount.

Parameters:

by - the amount to increment by

pushValue

protected final void pushValue()

Push the current value on the stack.

popValue

protected final BigInteger popValue()

Pops a value off the stack and makes it the current value.

Returns:

pop a value off the stack and make it the current value