KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > persistence > IdClass


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23 package javax.persistence;
24
25 import java.lang.annotation.Target JavaDoc;
26 import java.lang.annotation.Retention JavaDoc;
27 import static java.lang.annotation.ElementType.TYPE JavaDoc;
28 import static java.lang.annotation.RetentionPolicy.RUNTIME JavaDoc;
29
30 /**
31  * Specifies a composite primary key class that is mapped to
32  * multiple fields or properties of the entity.
33  *
34  * <p> The names of the fields or properties in the primary key
35  * class and the primary key fields or properties of the entity
36  * must correspond and their types must be the same.
37  *
38  * <pre>
39  *
40  * Example:
41  *
42  * &#064;IdClass(com.acme.EmployeePK.class)
43  * &#064;Entity
44  * public class Employee {
45  * &#064;Id String empName;
46  * &#064;Id Date birthDay;
47  * ...
48  * }
49  * </pre>
50  *
51  * @since Java Persistence 1.0
52  */

53 @Target JavaDoc({TYPE})
54 @Retention JavaDoc(RUNTIME)
55
56 public @interface IdClass {
57
58     /** Primary key class */
59     Class JavaDoc value();
60 }
61
Popular Tags