src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorType.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 whether fields or Javabean properties are serialized by default. </p>
ohair@286 38 *
ohair@286 39 * <p> <b> Usage </b> </p>
ohair@286 40 *
ohair@286 41 * <p> <tt>@XmlAccessorType</tt> annotation can be used with the following program elements:</p>
ohair@286 42 *
ohair@286 43 * <ul>
ohair@286 44 * <li> package</li>
ohair@286 45 * <li> a top level class </li>
ohair@286 46 * </ul>
ohair@286 47 *
ohair@286 48 * <p> See "Package Specification" in javax.xml.bind.package javadoc for
ohair@286 49 * additional common information.</p>
ohair@286 50 *
ohair@286 51 * <p>This annotation provides control over the default serialization
ohair@286 52 * of properties and fields in a class.
ohair@286 53 *
ohair@286 54 * <p>The annotation <tt> @XmlAccessorType </tt> on a package applies to
ohair@286 55 * all classes in the package. The following inheritance
ohair@286 56 * semantics apply:
ohair@286 57 *
ohair@286 58 * <ul>
ohair@286 59 * <li> If there is a <tt>@XmlAccessorType</tt> on a class, then it
ohair@286 60 * is used. </li>
ohair@286 61 * <li> Otherwise, if a <tt>@XmlAccessorType</tt> exists on one of
ohair@286 62 * its super classes, then it is inherited.
ohair@286 63 * <li> Otherwise, the <tt>@XmlAccessorType </tt> on a package is
ohair@286 64 * inherited.
ohair@286 65 * </ul>
ohair@286 66 * <p> <b> Defaulting Rules: </b> </p>
ohair@286 67 *
ohair@286 68 * <p>By default, if <tt>@XmlAccessorType </tt> on a package is absent,
ohair@286 69 * then the following package level annotation is assumed.</p>
ohair@286 70 * <pre>
ohair@286 71 * &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
ohair@286 72 * </pre>
ohair@286 73 * <p> By default, if <tt>@XmlAccessorType</tt> on a class is absent,
ohair@286 74 * and none of its super classes is annotated with
ohair@286 75 * <tt>@XmlAccessorType</tt>, then the following default on the class
ohair@286 76 * is assumed: </p>
ohair@286 77 * <pre>
ohair@286 78 * &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
ohair@286 79 * </pre>
ohair@286 80 * <p>This annotation can be used with the following annotations:
ohair@286 81 * {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder},
ohair@286 82 * {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes},
ohair@286 83 * , {@link XmlJavaTypeAdapter}. It can also be used with the
ohair@286 84 * following annotations at the package level: {@link XmlJavaTypeAdapter}.
ohair@286 85 *
ohair@286 86 * @author Sekhar Vajjhala, Sun Microsystems, Inc.
ohair@286 87 * @since JAXB2.0
ohair@286 88 * @see XmlAccessType
ohair@286 89 */
ohair@286 90
ohair@286 91 @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE})
ohair@286 92 public @interface XmlAccessorType {
ohair@286 93
ohair@286 94 /**
ohair@286 95 * Specifies whether fields or properties are serialized.
ohair@286 96 *
ohair@286 97 * @see XmlAccessType
ohair@286 98 */
ohair@286 99 XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER;
ohair@286 100 }

mercurial