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.RetentionPolicy.RUNTIME;
42:
43: /**
44: * Is used to specify a named query in the Java Persistence query language,
45: * which is a static query expressed in metadata.
46: * Query names are scoped to the persistence unit.
47: *
48: * <p> The following is an example of the definition of a named query
49: * in the Java Persistence query language:
50: *
51: * <pre>
52: * @NamedQuery(
53: * name="findAllCustomersWithName",
54: * query="SELECT c FROM Customer c WHERE c.name LIKE :custName"
55: * )
56: * </pre>
57: *
58: * <p> The following is an example of the use of a named query:
59: *
60: * <pre>
61: * @PersistenceContext
62: * public EntityManager em;
63: * ...
64: * customers = em.createNamedQuery("findAllCustomersWithName")
65: * .setParameter("custName", "Smith")
66: * .getResultList();
67: * </pre>
68: *
69: * @since Java Persistence 1.0
70: */
71: @Target({TYPE})
72: @Retention(RUNTIME)
73: public @interface NamedQuery {
74:
75: /**
76: * Refers to the query when using the {@link EntityManager}
77: * methods that create query objects.
78: */
79: String name();
80:
81: /** The query string in the Java Persistence query language */
82: String query();
83:
84: /** Vendor-specific query hints */
85: QueryHint[] hints() default {};
86: }
|