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.GenerationType.AUTO;
44:
45: /**
46: * Provides for the specification of generation strategies for
47: * the values of primary keys. The <code>GeneratedValue</code>
48: * annotation may be applied to a primary key property or
49: * field of an entity or mapped superclass in conjunction with
50: * the {@link Id} annotation.
51: *
52: * <pre>
53: *
54: * Example 1:
55: *
56: * @Id
57: * @GeneratedValue(strategy=SEQUENCE, generator="CUST_SEQ")
58: * @Column(name="CUST_ID")
59: * public Long getId() { return id; }
60: *
61: * Example 2:
62: *
63: * @Id
64: * @GeneratedValue(strategy=TABLE, generator="CUST_GEN")
65: * @Column(name="CUST_ID")
66: * Long id;
67: * </pre>
68: *
69: * @since Java Persistence 1.0
70: */
71: @Target({METHOD,FIELD})
72: @Retention(RUNTIME)
73: public @interface GeneratedValue {
74:
75: /**
76: * (Optional) The primary key generation strategy
77: * that the persistence provider must use to
78: * generate the annotated entity primary key.
79: */
80: GenerationType strategy() default AUTO;
81:
82: /**
83: * (Optional) The name of the primary key generator
84: * to use as specified in the {@link SequenceGenerator}
85: * or {@link TableGenerator} annotation.
86: * <p> Defaults to the id generator supplied by persistence provider.
87: */
88: String generator() default "";
89: }
|