Package com.puppycrawl.tools.checkstyle.checks.coding

Class UnnecessarySemicolonInEnumerationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public final class UnnecessarySemicolonInEnumerationCheck
extends AbstractCheck

    Checks if unnecessary semicolon is in enum definitions. Semicolon is not needed if enum body contains only enum constants.

    To configure the check: 

     <module name="UnnecessarySemicolonInEnumeration"/>

    Example of violations 

     enum One {
     A,B; // violation
 }
 enum Two {
     A,B,; // violation
 }
 enum Three {
     A,B(); // violation
 }
 enum Four {
     A,B{}; // violation
 }
 enum Five {
     A,
     B
     ; // violation
 }

    Example of good cases 

     enum Normal {
     A,
     B,
     ; // required ";", no violation
     Normal(){}
 }
 enum NoSemicolon {
     A, B // only enum constants, no semicolon required
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • unnecessary.semicolon
    Since:
    8.22

    • Field Detail

      • MSG_SEMI

        public static final java.lang.String MSG_SEMI
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • UnnecessarySemicolonInEnumerationCheck

        public UnnecessarySemicolonInEnumerationCheck()

    • 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 class AbstractCheck
        Returns:
        the default tokens
        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 class AbstractCheck
        Returns:
        the token set this check is designed for.
        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