com.puppycrawl.tools.checkstyle.checks.coding

Class DefaultComesLastCheck

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.DefaultComesLastCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class DefaultComesLastCheck
extends AbstractCheck

Check that the default is after all the cases in a switch statement.

Rationale: Java allows default anywhere within the switch statement. But it is more readable if it comes after the last case.

• Property skipIfLastAndSharedWithCase - Control whether to allow default along with case if they are not last. Default value is false.

To configure the check:

 <module name="DefaultComesLast"/>
 

To configure the check for skipIfLastAndSharedWithCase:

 <module name="DefaultComesLast">
   <property name="skipIfLastAndSharedWithCase" value="true"/>
 </module>
 

Example when skipIfLastAndSharedWithCase is set to true.

 switch (i) {
   case 1:
     break;
   case 2:
   default: // No violation with the new option is expected
     break;
   case 3:
     break;
 }
 switch (i) {
   case 1:
     break;
   default: // violation with the new option is expected
   case 2:
     break;
 }
 

Since:

3.4

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.
static java.lang.String	MSG_KEY_SKIP_IF_LAST_AND_SHARED_WITH_CASE A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
DefaultComesLastCheck()

Method Summary

Modifier and Type	Method and 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	setSkipIfLastAndSharedWithCase(boolean newValue) Setter to control whether to allow default along with case if they are not last.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_KEY

public static final java.lang.String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

MSG_KEY_SKIP_IF_LAST_AND_SHARED_WITH_CASE

public static final java.lang.String MSG_KEY_SKIP_IF_LAST_AND_SHARED_WITH_CASE

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

DefaultComesLastCheck

public DefaultComesLastCheck()

Method Detail

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 class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

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 class AbstractCheck

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 class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

setSkipIfLastAndSharedWithCase

public void setSkipIfLastAndSharedWithCase(boolean newValue)

Setter to control whether to allow default along with case if they are not last.

Parameters:

newValue - whether to ignore checking.

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process