DCL04-J. Do not derive a value associated with an enum from its ordinal

Java language enumeration types have an ordinal() method, which returns the numerical position of each enumeration constant in its class declaration.

The Java Language Specification [java:[JLS 2005]] §8.9, "Enums" does not specify the use of ordinal() in programs. However, using the ordinal() method to derive the value associated with an enum constant is error-prone and should be avoided.

According to the Java API [java:[API 2006]], public final int ordinal():

Returns the ordinal of the enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero). Most programmers will have no use for this method. It is designed for use by sophisticated enum-based data structures, such as EnumSet and EnumMap.

Noncompliant Code Example

This noncompliant code example declares enum Hydrocarbon and uses its ordinal() method to provide the result of the getNumberOfCarbons() method.

enum Hydrocarbon {
  METHANE, ETHANE, PROPANE, BUTANE, PENTANE,
  HEXANE, HEPTANE, OCTANE, NONANE, DECANE;

  public int getNumberOfCarbons() {
    return ordinal() + 1;
  }
}

While this noncompliant code example works, its maintenance is susceptible to vulnerabilities. If the enum constants were reordered, the getNumberOfCarbon() method would return incorrect values. Also, BENZENE - which also has 6 carbons - cannot be added without violating the current enum design.

Compliant Solution

In this compliant solution, enum constants are explicitly associated with the corresponding integer values for the number of carbon atoms they contain.

enum Hydrocarbon {
  METHANE(1), ETHANE(2), PROPANE(3), BUTANE(4), PENTANE(5),
  HEXANE(6), HEPTANE(7), OCTANE(8), NONANE(9), DECANE(10);

  private final int numberOfCarbons;

  Hydrocarbon(int carbons) { this.numberOfCarbons = carbons; }

  public int getNumberOfCarbons() {
    return numberOfCarbons;
  }
}

Risk Assessment

Use of ordinals to derive integer values reduces the program's maintainability and can lead to errors in the program.

Related Guidelines

Bibliography

DCL54-J. Enable compile-time type checking of varargs types      01. Declarations and Initialization (DCL)      DCL02-J. Declare all enhanced for statement loop variables final