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.TYPE;
41: import static java.lang.annotation.ElementType.METHOD;
42: import static java.lang.annotation.ElementType.FIELD;
43: import static java.lang.annotation.RetentionPolicy.RUNTIME;
44: import static javax.persistence.FetchType.EAGER;
45:
46: /**
47: * The <code>Basic</code> annotation is the simplest type of mapping
48: * to a database column. The <code>Basic</code> annotation can be
49: * applied to a persistent property or instance variable of any of the
50: * following types: Java primitive types, wrappers of the primitive types,
51: * {@link String}, {@link java.math.BigInteger java.math.BigInteger},
52: * {@link java.math.BigDecimal java.math.BigDecimal},
53: * {@link java.util.Date java.util.Date},
54: * {@link java.util.Calendar java.util.Calendar},
55: * {@link java.sql.Date java.sql.Date}, {@link java.sql.Time java.sql.Time},
56: * {@link java.sql.Timestamp java.sql.Timestamp}, <code>byte[], Byte[],
57: * char[], Character[]</code>, enums, and any other type that implements
58: * {@link java.io.Serializable Serializable}.
59: *
60: * <p> The use of the <code>Basic</code> annotation is optional for
61: * persistent fields and properties of these types.
62: *
63: * @since Java Persistence 1.0
64: */
65: @Target({METHOD,FIELD})
66: @Retention(RUNTIME)
67: public @interface Basic {
68:
69: /**
70: * (Optional) Defines whether the value of the field or property should
71: * be lazily loaded or must be eagerly fetched. The <code>EAGER</code>
72: * strategy is a requirement on the persistence provider runtime
73: * that the value must be eagerly fetched. The <code>LAZY</code>
74: * strategy is a hint to the persistence provider runtime.
75: * If not specified, defaults to <code>EAGER</code>.
76: */
77: FetchType fetch() default EAGER;
78:
79: /**
80: * (Optional) Defines whether the value of the field or property may be null.
81: * This is a hint and is disregarded for primitive types; it may
82: * be used in schema generation.
83: * If not specified, defaults to <code>true</code>.
84: */
85: boolean optional() default true;
86: }
|