Class UnnecessarySemicolonInEnumerationCheck

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

    • MSG_SEMI

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

  • Constructor Details

    • UnnecessarySemicolonInEnumerationCheck

      public UnnecessarySemicolonInEnumerationCheck()

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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

    • isEndOfEnumerationAfter

      private static boolean isEndOfEnumerationAfter(DetailAST ast)
      Checks if enum body has no code elements after enum constants semicolon.
      Parameters:
      ast - semicolon in enum constants definition end
      Returns:
      true if there is no code elements, false otherwise.