Revision as of 11:23, 2 May 2011

EclipseLink
Website
Download
Community
Mailing List • Forums • IRC • mattermost
Issues
Open • Help Wanted • Bug Day
Contribute
Browse Source

Key API

• @Enumerated

@Enumerated

By default, EclipseLink persistence provider persists the ordinal values of enumerated constants.

Use the @Enumerated annotation to specify whether EclipseLink persistence provider should persist ordinal or String values of enumerated constants if the String value suits your application requirements, or to match an existing database schema:

You can use this annotation with the @Basic annotation.

Given the enumerated constants in the Enumerated Constants example, the Usage of the @Enumerated Annotation example shows how to use the @Enumerated annotation to specify that the String value of SalaryRate should be written to the database when Employee is persisted. By default, the ordinal value of EmployeeStatus is written to the database.

Example: Enumerated Constants

 public enum EmployeeStatus {FULL_TIME, PART_TIME, CONTRACT}
 public enum SalaryRate {JUNIOR, SENIOR, MANAGER, EXECUTIVE}

Example: @Enumerated Annotation

 @Entity
 public class Employee implements Serializable{
     ...
     public EmployeeStatus getStatus() {
         ...
     }
 
     @Enumerated(STRING)
     public SalaryRate getRate() {
         ...
     }
     ...
 }

For more information, see Section 9.1.21 "Enumerated Annotation" in the JPA Specification.

@Basic	Basic Mappings	@Temporal
EclipseLink Home JPA User Guide: Table of Contents, Search
How to contribute to this guide...