175 words

javax.persistence.Enumerated - JPA annotation

javax.persistence
Annotation Enumerated

Target:
Fields (including property get methods)
Specifies that a persistent property or field should be persisted as a enumerated type. The Enumerated annotation may be used in conjunction with the Basic annotation, or in conjunction with the ElementCollection annotation when the element collection value is of basic type. If the enumerated type is not specified or the Enumerated annotation is not used, the EnumType value is assumed to be ORDINAL.

Example:

   public enum EmployeeStatus {FULL_TIME, PART_TIME, CONTRACT}
 
   public enum SalaryRate {JUNIOR, SENIOR, MANAGER, EXECUTIVE}
 
   @Entity public class Employee {
       public EmployeeStatus getStatus() {...}
       ...
       @Enumerated(STRING)
       public SalaryRate getPayScale() {...}
       ...
   }
Since:
JPA 1.0
See Also:
Basic
ElementCollection
Learn how to define and use enum fields in Chapter 2 of the ObjectDB/JPA manual.
(Optional) The type used in mapping an enum type.
(Optional) The type used in mapping an enum type.
Default value:
javax.persistence.EnumType.ORDINAL
Since:
JPA 1.0

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.