public class FallThroughCheck extends Check
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 and Description |
---|
FallThroughCheck()
Creates new instance of the check.
|
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
init()
Initialse 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.
|
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getTabWidth, getTokenNames, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
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()
public void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to process