Class 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 if it comes after the last case then it is more readable.

    An example of how to configure the check is:

     <module name="DefaultComesLast"/>
     
    • Field Detail

      • MSG_KEY

        public static final 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 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)
        Whether to allow default keyword not in last but surrounded with case.
        Parameters:
        newValue - whether to ignore checking.