Enum in Apex
An enum is an abstract data type with values that each take on exactly one of a finite set of identifiers that you specify. Enums are typically used to define a set of possible values.
Although each value corresponds to a distinct integer value, the enum hides this implementation so that you don’t inadvertently misuse the values, such as using them to perform arithmetic. After you create an enum, variables, method arguments, and return types can be declared of that type. Apex provides built-in enums, such as LoggingLevel, and you can define your own enum.
To define an enum, use the enum keyword in your declaration and use curly braces to demarcate the list of possible values.
For Example:
The following code creates an enum called Season:
public enum Season {WINTER, SPRING, SUMMER, FALL}
By creating the enum Season, you have also created a new data type called Season. You can use this new data type as you might any other data type.
For Example:
Season e = Season.WINTER; Season CheckSeason(Season e) { if (e == Season.SUMMER){ return e; } }
Enum Methods:
All Apex enums, whether user-defined enums or built-in enums, have the following common method that takes no arguments.
values
: This method returns the values of the Enum as a list of the same Enum type. Each Enum value has the following methods that take no arguments.
name
: Returns the name of the Enum item as a String.
ordinal
: Returns the position of the item, as an Integer, in the list of Enum values starting with zero.
Note: Enum values cannot have user-defined methods added to them.
For Example:
Integer i = StatusCode.DELETE_FAILED.ordinal(); String s = StatusCode.DELETE_FAILED.name(); List<StatusCode> values = StatusCode.values();