01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence;
37:
38: import java.lang.annotation.Target;
39: import java.lang.annotation.Retention;
40: import static java.lang.annotation.ElementType.FIELD;
41: import static java.lang.annotation.ElementType.METHOD;
42: import static java.lang.annotation.RetentionPolicy.RUNTIME;
43: import static javax.persistence.EnumType.ORDINAL;
44:
45: /**
46: * Specifies that a persistent property or field should be
47: * persisted as a enumerated type. It may be used in conjunction
48: * with the {@link Basic} annotation.
49: *
50: * <pre>
51: * Example:
52: *
53: * public enum EmployeeStatus {FULL_TIME, PART_TIME, CONTRACT}
54: *
55: * public enum SalaryRate {JUNIOR, SENIOR, MANAGER, EXECUTIVE}
56: *
57: * @Entity public class Employee {
58: * public EmployeeStatus getStatus() {...}
59: * @Enumerated(STRING)
60: * public SalaryRate getPayScale() {...}
61: * ...
62: * }
63: * </pre>
64: *
65: * @since Java Persistence 1.0
66: */
67: @Target({METHOD,FIELD})
68: @Retention(RUNTIME)
69: public @interface Enumerated {
70:
71: /** (Optional) The type used in mapping an enum type. */
72: EnumType value() default ORDINAL;
73: }
|