com.puppycrawl.tools.checkstyle.checks.coding

Class ReturnCountCheck

public final class ReturnCountCheck extends AbstractFormatCheck

Restricts return statements to a specified count (default = 2). Ignores specified methods (equals() by default).

Rationale: Too many return points can be indication that code is attempting to do too much or may be difficult to understand.

Author: Simon Harris TODO: Test for inside a static block

Constructor Summary
	ReturnCountCheck() Creates new instance of the checks.

Method Summary
void	beginTree(DetailAST aRootAST)
int[]	getDefaultTokens()
int	getMax() Getter for max property.
int[]	getRequiredTokens()
void	leaveToken(DetailAST aAST)
void	setMax(int aMax) Setter for max property.
void	visitToken(DetailAST aAST)

Constructor Detail

public ReturnCountCheck()

Creates new instance of the checks.

public void beginTree(DetailAST aRootAST)

{@inheritDoc }

public int[] getDefaultTokens()

{@inheritDoc }

public int getMax()

Getter for max property.

Returns: maximum allowed number of return statements.

public int[] getRequiredTokens()

{@inheritDoc }

public void leaveToken(DetailAST aAST)

{@inheritDoc }

public void setMax(int aMax)

Setter for max property.

Parameters: aMax maximum allowed number of return statements.

public void visitToken(DetailAST aAST)

{@inheritDoc }