Package io.camunda.zeebe.protocol

Interface EnumValue

All Known Implementing Classes:

ZbColumnFamilies

public interface EnumValue

Interface for enum values that have a numeric value associated with them. This is used to avoid using the ordinal value of an enum, which is fragile when the enum values are reordered.

In the Zeebe repo, reordering of enum values can typically occur by accident when backporting additions to the enum. While we try our best to add values to the bottom of the enum, backporting can still cause reordering issues. This is because while one addition may be backported, another could easily be missed. This would result in the backported enum having a different ordinal value than the original, which would cause issues when serializing/deserializing.

For example, if we have an enum with values A, B, C, D, and E, and we backport the addition of E to an older version of the enum, we may accidentally miss backporting the addition of D. This would result in the backported enum having values A, B, C, E. The value associated with E would differ semantically but have the same ordinal between the original and backported enum.

By using this interface, we can avoid this issue by explicitly setting the value associated.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the numeric value associated with this enum value.

Method Details

getValue

int getValue()

Returns the numeric value associated with this enum value.