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