|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.Check
com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
public class FallThroughCheck
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>
Constructor Summary | |
---|---|
FallThroughCheck()
Creates new instance of the check. |
Method Summary | |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in. |
int[] |
getRequiredTokens()
The tokens that this check must be registered for. |
void |
init()
Initialise the check. |
void |
setCheckLastCaseGroup(boolean aValue)
Configures whether we need to check last case group or not. |
void |
setReliefPattern(String aPattern)
Set the relief pattern. |
void |
visitToken(DetailAST aAST)
Called to process a token. |
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check |
---|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, leaveToken, 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 |
---|
public FallThroughCheck()
Method Detail |
---|
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void setReliefPattern(String aPattern)
aPattern
- The regular expression pattern.public void setCheckLastCaseGroup(boolean aValue)
aValue
- new value of the property.public void init()
Check
init
in class Check
public void visitToken(DetailAST aAST)
Check
visitToken
in class Check
aAST
- the token to process
|
Back to the Checkstyle Home Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |