Class FallThroughCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class FallThroughCheck extends AbstractCheck
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" and absence of any Java code in case 5.
case 3: x = 2; // fallthru case 4: case 5: case 6: break;
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>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static String
MSG_FALL_THROUGH
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_FALL_THROUGH_LAST
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description FallThroughCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.void
setCheckLastCaseGroup(boolean value)
Configures whether we need to check last case group or not.void
setReliefPattern(Pattern pattern)
Set the relief pattern.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_FALL_THROUGH
public static final String MSG_FALL_THROUGH
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_FALL_THROUGH_LAST
public static final String MSG_FALL_THROUGH_LAST
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
setReliefPattern
public void setReliefPattern(Pattern pattern)
Set the relief pattern.- Parameters:
pattern
- The regular expression pattern.
-
setCheckLastCaseGroup
public void setCheckLastCaseGroup(boolean value)
Configures whether we need to check last case group or not.- Parameters:
value
- new value of the property.
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
-