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 javax.persistence.CascadeType;
41: import static java.lang.annotation.ElementType.FIELD;
42: import static java.lang.annotation.ElementType.METHOD;
43: import static java.lang.annotation.RetentionPolicy.RUNTIME;
44: import static javax.persistence.FetchType.EAGER;
45:
46: /**
47: * This annotation defines a single-valued association to another
48: * entity class that has many-to-one multiplicity. It is not normally
49: * necessary to specify the target entity explicitly since it can
50: * usually be inferred from the type of the object being referenced.
51: *
52: * <pre>
53: *
54: * Example:
55: *
56: * @ManyToOne(optional=false)
57: * @JoinColumn(name="CUST_ID", nullable=false, updatable=false)
58: * public Customer getCustomer() { return customer; }
59: * </pre>
60: *
61: * @since Java Persistence 1.0
62: */
63: @Target({METHOD,FIELD})
64: @Retention(RUNTIME)
65: public @interface ManyToOne {
66:
67: /**
68: * (Optional) The entity class that is the target of
69: * the association.
70: *
71: * <p> Defaults to the type of the field or property
72: * that stores the association.
73: */
74: Class targetEntity() default void.class;
75:
76: /**
77: * (Optional) The operations that must be cascaded to
78: * the target of the association.
79: *
80: * <p> By default no operations are cascaded.
81: */
82: CascadeType[] cascade() default {};
83:
84: /**
85: * (Optional) Whether the association should be lazily
86: * loaded or must be eagerly fetched. The {@link FetchType#EAGER EAGER}
87: * strategy is a requirement on the persistence provider runtime that
88: * the associated entity must be eagerly fetched. The {@link FetchType#LAZY
89: * LAZY} strategy is a hint to the persistence provider runtime.
90: */
91: FetchType fetch() default EAGER;
92:
93: /**
94: * (Optional) Whether the association is optional. If set
95: * to false then a non-null relationship must always exist.
96: */
97: boolean optional() default true;
98: }
|