aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.xml.bind.annotation;
aoqi@0: 
aoqi@0: import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
aoqi@0: import java.lang.annotation.Target;
aoqi@0: import java.lang.annotation.Retention;
aoqi@0: import java.lang.annotation.Inherited;
aoqi@0: 
aoqi@0: import static java.lang.annotation.ElementType.*;
aoqi@0: import static java.lang.annotation.RetentionPolicy.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * <p> Controls whether fields or Javabean properties are serialized by default. </p>
aoqi@0:  *
aoqi@0:  * <p> <b> Usage </b> </p>
aoqi@0:  *
aoqi@0:  * <p> <tt>@XmlAccessorType</tt> annotation can be used with the following program elements:</p>
aoqi@0:  *
aoqi@0:  * <ul>
aoqi@0:  *   <li> package</li>
aoqi@0:  *   <li> a top level class </li>
aoqi@0:  * </ul>
aoqi@0:  *
aoqi@0:  * <p> See "Package Specification" in javax.xml.bind.package javadoc for
aoqi@0:  * additional common information.</p>
aoqi@0:  *
aoqi@0:  * <p>This annotation provides control over the default serialization
aoqi@0:  * of properties and fields in a class.
aoqi@0:  *
aoqi@0:  * <p>The annotation <tt> @XmlAccessorType </tt> on a package applies to
aoqi@0:  * all classes in the package. The following inheritance
aoqi@0:  * semantics apply:
aoqi@0:  *
aoqi@0:  * <ul>
aoqi@0:  *   <li> If there is a <tt>@XmlAccessorType</tt> on a class, then it
aoqi@0:  *        is used. </li>
aoqi@0:  *   <li> Otherwise, if a <tt>@XmlAccessorType</tt> exists on one of
aoqi@0:  *        its super classes, then it is inherited.
aoqi@0:  *   <li> Otherwise, the <tt>@XmlAccessorType </tt> on a package is
aoqi@0:  *        inherited.
aoqi@0:  * </ul>
aoqi@0:  * <p> <b> Defaulting Rules: </b> </p>
aoqi@0:  *
aoqi@0:  * <p>By default, if <tt>@XmlAccessorType </tt> on a package is absent,
aoqi@0:  * then the following package level annotation is assumed.</p>
aoqi@0:  * <pre>
aoqi@0:  *   &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
aoqi@0:  * </pre>
aoqi@0:  * <p> By default, if <tt>@XmlAccessorType</tt> on a class is absent,
aoqi@0:  * and none of its super classes is annotated with
aoqi@0:  * <tt>@XmlAccessorType</tt>, then the following default on the class
aoqi@0:  * is assumed: </p>
aoqi@0:  * <pre>
aoqi@0:  *   &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
aoqi@0:  * </pre>
aoqi@0:  * <p>This annotation can be used with the following annotations:
aoqi@0:  *    {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder},
aoqi@0:  *    {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes},
aoqi@0:  *    , {@link XmlJavaTypeAdapter}. It can also be used with the
aoqi@0:  *    following annotations at the package level: {@link XmlJavaTypeAdapter}.
aoqi@0:  *
aoqi@0:  * @author Sekhar Vajjhala, Sun Microsystems, Inc.
aoqi@0:  * @since JAXB2.0
aoqi@0:  * @see XmlAccessType
aoqi@0:  */
aoqi@0: 
aoqi@0: @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE})
aoqi@0: public @interface XmlAccessorType {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Specifies whether fields or properties are serialized.
aoqi@0:      *
aoqi@0:      * @see XmlAccessType
aoqi@0:      */
aoqi@0:     XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER;
aoqi@0: }