com.puppycrawl.tools.checkstyle.checks.design

Class ThrowsCountCheck

public final class ThrowsCountCheck extends Check

Restricts throws statements to a specified count (default = 1).

Rationale: Exceptions form part of a methods interface. Declaring a method to throw too many differently rooted exceptions makes exception handling onerous and leads to poor programming practices such as catch (Exception). This check forces developers to put exceptions into a heirachy such that in the simplest case, only one type of exception need be checked for by a caller but allows any sub-classes to be caught specifically if necessary.

Author: Simon Harris

Constructor Summary
ThrowsCountCheck()
Creates new instance of the check.
Method Summary
int[]getDefaultTokens()
{@inheritDoc}
intgetMax()
Getter for max property.
int[]getRequiredTokens()
{@inheritDoc}
voidsetMax(int aMax)
Setter for max property.
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Constructor Detail

ThrowsCountCheck

public ThrowsCountCheck()
Creates new instance of the check.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

getMax

public int getMax()
Getter for max property.

Returns: maximum allowed throws statements.

getRequiredTokens

public int[] getRequiredTokens()
{@inheritDoc}

setMax

public void setMax(int aMax)
Setter for max property.

Parameters: aMax maximum allowed throws statements.

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc}