-
@Target({METHOD,FIELD}) @Retention(RUNTIME) public @interface Enumerated
Specifies that a persistent property or field should be persisted as an enumerated type. This annotation is optional if the type of a persistent field or property is a Javaenum
type.The
Enumerated
annotation may be used in conjunction with theBasic
annotation, or in conjunction with theElementCollection
annotation when the element type of the collection is an enum type.An enum can be mapped as either a string or an integer, where
EnumType
enumerates the available options. The mapping may be explicitly specified by this annotation.If a persistent field or property of enum type has no explicit
Enumerated
annotation, and if no converter is applied to the field or property:- if the enum type has a final field of type
String
annotatedEnumeratedValue
, the enumerated type is inferred to beEnumType.STRING
; - otherwise, the enumerated type is taken to be
EnumType.ORDINAL
.
Example: {@snippet : public enum EmployeeStatus {FULL_TIME, PART_TIME, CONTRACT} public enum SalaryRate {JUNIOR, SENIOR, MANAGER, EXECUTIVE}
- Since:
- 1.0
- See Also:
EnumeratedValue
,Basic
,ElementCollection
- if the enum type has a final field of type
-
-
Element Detail
-
value
EnumType value
(Optional) The type used in mapping an enum type.- Default:
- jakarta.persistence.EnumType.ORDINAL
-
-