Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorOrder.java@0989ad8c0860 (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorOrder.java
Tue, 09 Apr 2013 14:51:13 +0100
- author
- alanb
- date
- Tue, 09 Apr 2013 14:51:13 +0100
- changeset 368
- 0989ad8c0860
- parent 286
- f50545b5e2f1
- child 397
- b99d7e355d4b
- permissions
- -rw-r--r--
8010393: Update JAX-WS RI to 2.2.9-b12941
Reviewed-by: alanb, erikj
Contributed-by: miroslav.kos@oracle.com, martin.grebac@oracle.com
| ohair@286 | 1 | /* |
| ohair@286 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
| ohair@286 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| ohair@286 | 4 | * |
| ohair@286 | 5 | * This code is free software; you can redistribute it and/or modify it |
| ohair@286 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@286 | 7 | * published by the Free Software Foundation. Oracle designates this |
| ohair@286 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@286 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| ohair@286 | 10 | * |
| ohair@286 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| ohair@286 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| ohair@286 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| ohair@286 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| ohair@286 | 15 | * accompanied this code). |
| ohair@286 | 16 | * |
| ohair@286 | 17 | * You should have received a copy of the GNU General Public License version |
| ohair@286 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| ohair@286 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| ohair@286 | 20 | * |
| ohair@286 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@286 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@286 | 23 | * questions. |
| ohair@286 | 24 | */ |
| ohair@286 | 25 | |
| ohair@286 | 26 | package javax.xml.bind.annotation; |
| ohair@286 | 27 | |
| ohair@286 | 28 | import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; |
| ohair@286 | 29 | import java.lang.annotation.Target; |
| ohair@286 | 30 | import java.lang.annotation.Retention; |
| ohair@286 | 31 | import java.lang.annotation.Inherited; |
| ohair@286 | 32 | |
| ohair@286 | 33 | import static java.lang.annotation.ElementType.*; |
| ohair@286 | 34 | import static java.lang.annotation.RetentionPolicy.*; |
| ohair@286 | 35 | |
| ohair@286 | 36 | /** |
| ohair@286 | 37 | * <p> Controls the ordering of fields and properties in a class. </p> |
| ohair@286 | 38 | * |
| ohair@286 | 39 | * <h3>Usage </h3> |
| ohair@286 | 40 | * |
| ohair@286 | 41 | * <p> <tt> @XmlAccessorOrder </tt> annotation can be used with the following |
| ohair@286 | 42 | * program elements:</p> |
| ohair@286 | 43 | * |
| ohair@286 | 44 | * <ul> |
| ohair@286 | 45 | * <li> package</li> |
| ohair@286 | 46 | * <li> a top level class </li> |
| ohair@286 | 47 | * </ul> |
| ohair@286 | 48 | * |
| ohair@286 | 49 | * <p> See "Package Specification" in <tt>javax.xml.bind</tt> package javadoc for |
| ohair@286 | 50 | * additional common information.</p> |
| ohair@286 | 51 | * |
| ohair@286 | 52 | * <p>The effective {@link XmlAccessOrder} on a class is determined |
| ohair@286 | 53 | * as follows: |
| ohair@286 | 54 | * |
| ohair@286 | 55 | * <ul> |
| ohair@286 | 56 | * <li> If there is a <tt>@XmlAccessorOrder</tt> on a class, then |
| ohair@286 | 57 | * it is used. </li> |
| ohair@286 | 58 | * <li> Otherwise, if a <tt>@XmlAccessorOrder </tt> exists on one of |
| ohair@286 | 59 | * its super classes, then it is inherited (by the virtue of |
| ohair@286 | 60 | * {@link Inherited}) |
| ohair@286 | 61 | * <li> Otherwise, the <tt>@XmlAccessorOrder</tt> on the package |
| ohair@286 | 62 | * of the class is used, if it's there. |
| ohair@286 | 63 | * <li> Otherwise {@link XmlAccessOrder#UNDEFINED}. |
| ohair@286 | 64 | * </ul> |
| ohair@286 | 65 | * |
| ohair@286 | 66 | * <p>This annotation can be used with the following annotations: |
| ohair@286 | 67 | * {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorType}, |
| ohair@286 | 68 | * {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}, |
| ohair@286 | 69 | * , {@link XmlJavaTypeAdapter}. It can also be used with the |
| ohair@286 | 70 | * following annotations at the package level: {@link XmlJavaTypeAdapter}. |
| ohair@286 | 71 | * |
| ohair@286 | 72 | * @author Sekhar Vajjhala, Sun Microsystems, Inc. |
| ohair@286 | 73 | * @since JAXB2.0 |
| ohair@286 | 74 | * @see XmlAccessOrder |
| ohair@286 | 75 | */ |
| ohair@286 | 76 | |
| ohair@286 | 77 | @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE}) |
| ohair@286 | 78 | public @interface XmlAccessorOrder { |
| ohair@286 | 79 | XmlAccessOrder value() default XmlAccessOrder.UNDEFINED; |
| ohair@286 | 80 | } |
