Mercurial > jdk8-mips64-public > jaxws / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/jaxws_classes/javax/xml/bind/annotation/XmlAccessorType.java	Tue Mar 06 16:09:35 2012 -0800
     1.3 @@ -0,0 +1,100 @@
     1.4 +/*
     1.5 + * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package javax.xml.bind.annotation;
    1.30 +
    1.31 +import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
    1.32 +import java.lang.annotation.Target;
    1.33 +import java.lang.annotation.Retention;
    1.34 +import java.lang.annotation.Inherited;
    1.35 +
    1.36 +import static java.lang.annotation.ElementType.*;
    1.37 +import static java.lang.annotation.RetentionPolicy.*;
    1.38 +
    1.39 +/**
    1.40 + * <p> Controls whether fields or Javabean properties are serialized by default. </p>
    1.41 + *
    1.42 + * <p> <b> Usage </b> </p>
    1.43 + *
    1.44 + * <p> <tt>@XmlAccessorType</tt> annotation can be used with the following program elements:</p>
    1.45 + *
    1.46 + * <ul>
    1.47 + *   <li> package</li>
    1.48 + *   <li> a top level class </li>
    1.49 + * </ul>
    1.50 + *
    1.51 + * <p> See "Package Specification" in javax.xml.bind.package javadoc for
    1.52 + * additional common information.</p>
    1.53 + *
    1.54 + * <p>This annotation provides control over the default serialization
    1.55 + * of properties and fields in a class.
    1.56 + *
    1.57 + * <p>The annotation <tt> @XmlAccessorType </tt> on a package applies to
    1.58 + * all classes in the package. The following inheritance
    1.59 + * semantics apply:
    1.60 + *
    1.61 + * <ul>
    1.62 + *   <li> If there is a <tt>@XmlAccessorType</tt> on a class, then it
    1.63 + *        is used. </li>
    1.64 + *   <li> Otherwise, if a <tt>@XmlAccessorType</tt> exists on one of
    1.65 + *        its super classes, then it is inherited.
    1.66 + *   <li> Otherwise, the <tt>@XmlAccessorType </tt> on a package is
    1.67 + *        inherited.
    1.68 + * </ul>
    1.69 + * <p> <b> Defaulting Rules: </b> </p>
    1.70 + *
    1.71 + * <p>By default, if <tt>@XmlAccessorType </tt> on a package is absent,
    1.72 + * then the following package level annotation is assumed.</p>
    1.73 + * <pre>
    1.74 + *   &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
    1.75 + * </pre>
    1.76 + * <p> By default, if <tt>@XmlAccessorType</tt> on a class is absent,
    1.77 + * and none of its super classes is annotated with
    1.78 + * <tt>@XmlAccessorType</tt>, then the following default on the class
    1.79 + * is assumed: </p>
    1.80 + * <pre>
    1.81 + *   &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
    1.82 + * </pre>
    1.83 + * <p>This annotation can be used with the following annotations:
    1.84 + *    {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder},
    1.85 + *    {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes},
    1.86 + *    , {@link XmlJavaTypeAdapter}. It can also be used with the
    1.87 + *    following annotations at the package level: {@link XmlJavaTypeAdapter}.
    1.88 + *
    1.89 + * @author Sekhar Vajjhala, Sun Microsystems, Inc.
    1.90 + * @since JAXB2.0
    1.91 + * @see XmlAccessType
    1.92 + */
    1.93 +
    1.94 +@Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE})
    1.95 +public @interface XmlAccessorType {
    1.96 +
    1.97 +    /**
    1.98 +     * Specifies whether fields or properties are serialized.
    1.99 +     *
   1.100 +     * @see XmlAccessType
   1.101 +     */
   1.102 +    XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER;
   1.103 +}