- java.lang.Object
-
- java.lang.Enum<EnumType>
-
- jakarta.persistence.EnumType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<EnumType>
public enum EnumType extends java.lang.Enum<EnumType>
Enumerates available options for mapping enumerated types. The values of this enumeration specify how a persistent property or field whose type is a Javaenum
type should be persisted.- Since:
- 1.0
- See Also:
Enumerated
,EnumeratedValue
-
-
Constructor Summary
Constructors Modifier Constructor Description private
EnumType()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static EnumType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static EnumType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
ORDINAL
public static final EnumType ORDINAL
Persist enumerated type property or field as an integer. The ordinal value of an enum instance with noEnumeratedValue
field is the value of itsEnum.ordinal()
member.
-
STRING
public static final EnumType STRING
Persist enumerated type property or field as a string. The string value of an enum instance with noEnumeratedValue
field is the value of itsEnum.name()
member.
-
-
Method Detail
-
values
public static EnumType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (EnumType c : EnumType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EnumType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-