Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorType.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorType.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 397
- b99d7e355d4b
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.xml.bind.annotation; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter; |
| aoqi@0 | 29 | import java.lang.annotation.Target; |
| aoqi@0 | 30 | import java.lang.annotation.Retention; |
| aoqi@0 | 31 | import java.lang.annotation.Inherited; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | import static java.lang.annotation.ElementType.*; |
| aoqi@0 | 34 | import static java.lang.annotation.RetentionPolicy.*; |
| aoqi@0 | 35 | |
| aoqi@0 | 36 | /** |
| aoqi@0 | 37 | * <p> Controls whether fields or Javabean properties are serialized by default. </p> |
| aoqi@0 | 38 | * |
| aoqi@0 | 39 | * <p> <b> Usage </b> </p> |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * <p> <tt>@XmlAccessorType</tt> annotation can be used with the following program elements:</p> |
| aoqi@0 | 42 | * |
| aoqi@0 | 43 | * <ul> |
| aoqi@0 | 44 | * <li> package</li> |
| aoqi@0 | 45 | * <li> a top level class </li> |
| aoqi@0 | 46 | * </ul> |
| aoqi@0 | 47 | * |
| aoqi@0 | 48 | * <p> See "Package Specification" in javax.xml.bind.package javadoc for |
| aoqi@0 | 49 | * additional common information.</p> |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * <p>This annotation provides control over the default serialization |
| aoqi@0 | 52 | * of properties and fields in a class. |
| aoqi@0 | 53 | * |
| aoqi@0 | 54 | * <p>The annotation <tt> @XmlAccessorType </tt> on a package applies to |
| aoqi@0 | 55 | * all classes in the package. The following inheritance |
| aoqi@0 | 56 | * semantics apply: |
| aoqi@0 | 57 | * |
| aoqi@0 | 58 | * <ul> |
| aoqi@0 | 59 | * <li> If there is a <tt>@XmlAccessorType</tt> on a class, then it |
| aoqi@0 | 60 | * is used. </li> |
| aoqi@0 | 61 | * <li> Otherwise, if a <tt>@XmlAccessorType</tt> exists on one of |
| aoqi@0 | 62 | * its super classes, then it is inherited. |
| aoqi@0 | 63 | * <li> Otherwise, the <tt>@XmlAccessorType </tt> on a package is |
| aoqi@0 | 64 | * inherited. |
| aoqi@0 | 65 | * </ul> |
| aoqi@0 | 66 | * <p> <b> Defaulting Rules: </b> </p> |
| aoqi@0 | 67 | * |
| aoqi@0 | 68 | * <p>By default, if <tt>@XmlAccessorType </tt> on a package is absent, |
| aoqi@0 | 69 | * then the following package level annotation is assumed.</p> |
| aoqi@0 | 70 | * <pre> |
| aoqi@0 | 71 | * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) |
| aoqi@0 | 72 | * </pre> |
| aoqi@0 | 73 | * <p> By default, if <tt>@XmlAccessorType</tt> on a class is absent, |
| aoqi@0 | 74 | * and none of its super classes is annotated with |
| aoqi@0 | 75 | * <tt>@XmlAccessorType</tt>, then the following default on the class |
| aoqi@0 | 76 | * is assumed: </p> |
| aoqi@0 | 77 | * <pre> |
| aoqi@0 | 78 | * @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) |
| aoqi@0 | 79 | * </pre> |
| aoqi@0 | 80 | * <p>This annotation can be used with the following annotations: |
| aoqi@0 | 81 | * {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder}, |
| aoqi@0 | 82 | * {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}, |
| aoqi@0 | 83 | * , {@link XmlJavaTypeAdapter}. It can also be used with the |
| aoqi@0 | 84 | * following annotations at the package level: {@link XmlJavaTypeAdapter}. |
| aoqi@0 | 85 | * |
| aoqi@0 | 86 | * @author Sekhar Vajjhala, Sun Microsystems, Inc. |
| aoqi@0 | 87 | * @since JAXB2.0 |
| aoqi@0 | 88 | * @see XmlAccessType |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | |
| aoqi@0 | 91 | @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE}) |
| aoqi@0 | 92 | public @interface XmlAccessorType { |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | /** |
| aoqi@0 | 95 | * Specifies whether fields or properties are serialized. |
| aoqi@0 | 96 | * |
| aoqi@0 | 97 | * @see XmlAccessType |
| aoqi@0 | 98 | */ |
| aoqi@0 | 99 | XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER; |
| aoqi@0 | 100 | } |
