com.puppycrawl.tools.checkstyle.checks.coding

Class FallThroughCheck

public class FallThroughCheck extends Check

Checks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.

The check honors special comments to suppress warnings about the fall through. By default the comments "fallthru", "fall through", "falls through" and "fallthrough" are recognized.

The following fragment of code will NOT trigger the check, because of the comment "fallthru".

 case 3:
     x = 2;
     // fallthru
 case 4:
 

The recognized relief comment can be configured with the property reliefPattern. Default value of this regular expression is "fallthru|fall through|fallthrough|falls through".

An example of how to configure the check is:

 <module name="FallThrough">
     <property name="reliefPattern"
                  value="Fall Through"/>
 </module>
 

Author: o_sukhodolsky

Constructor Summary
FallThroughCheck()
Creates new instance of the check.
Method Summary
int[]getDefaultTokens()
{@inheritDoc}
int[]getRequiredTokens()
{@inheritDoc}
voidinit()
{@inheritDoc}
voidsetCheckLastCaseGroup(boolean aValue)
Configures whether we need to check last case group or not.
voidsetReliefPattern(String aPattern)
Set the relief pattern.
voidvisitToken(DetailAST aAST)
{@inheritDoc}

Constructor Detail

FallThroughCheck

public FallThroughCheck()
Creates new instance of the check.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

getRequiredTokens

public int[] getRequiredTokens()
{@inheritDoc}

init

public void init()
{@inheritDoc}

setCheckLastCaseGroup

public void setCheckLastCaseGroup(boolean aValue)
Configures whether we need to check last case group or not.

Parameters: aValue new value of the property.

setReliefPattern

public void setReliefPattern(String aPattern)
Set the relief pattern.

Parameters: aPattern The regular expression pattern.

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc}