NoEnumTrailingComma

Since Checkstyle 8.29

Description

Checks that enum definition does not contain a trailing comma. Rationale: JLS allows trailing commas in arrays and enumerations, but does not allow them in other locations. To unify the coding style, the use of trailing commas should be prohibited.

enum Foo1 {
  FOO,
  BAR;
}
        

The check demands that there should not be any comma after last constant in enum definition.

enum Foo1 {
  FOO,
  BAR, //violation
}
        

Examples

To configure the check:

<module name="Checker">
  <module name="TreeWalker">
    <module name="NoEnumTrailingComma"/>
  </module>
</module>
        

Which results in the following violations:

enum Foo1 {
  FOO,
  BAR; //OK
}
enum Foo2 {
  FOO,
  BAR //OK
}
enum Foo3 {
  FOO,
  BAR, //violation
}
enum Foo4 {
  FOO,
  BAR, // violation
  ;
}
enum Foo5 {
  FOO,
  BAR,; // violation
}
enum Foo6 { FOO, BAR,; } // violation
enum Foo7 { FOO, BAR, } // violation
enum Foo8 {
  FOO,
  BAR // OK
  ;
}
enum Foo9 { FOO, BAR; } // OK
enum Foo10 { FOO, BAR } // OK
        

Example of Usage

Violation Messages

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.coding

Parent Module

TreeWalker