/*
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.xml.bind.annotation;

import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
import java.lang.annotation.Target;
import java.lang.annotation.Retention;
import java.lang.annotation.Inherited;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

Controls whether fields or Javabean properties are serialized by default.

Usage

@XmlAccessorType annotation can be used with the following program elements:

  • package
  • a top level class

See "Package Specification" in javax.xml.bind.package javadoc for additional common information.

This annotation provides control over the default serialization of properties and fields in a class.

The annotation @XmlAccessorType on a package applies to all classes in the package. The following inheritance semantics apply:

  • If there is a @XmlAccessorType on a class, then it is used.
  • Otherwise, if a @XmlAccessorType exists on one of its super classes, then it is inherited.
  • Otherwise, the @XmlAccessorType on a package is inherited.

Defaulting Rules:

By default, if @XmlAccessorType on a package is absent, then the following package level annotation is assumed.

  @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)

By default, if @XmlAccessorType on a class is absent, and none of its super classes is annotated with @XmlAccessorType, then the following default on the class is assumed:

  @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)

This annotation can be used with the following annotations: XmlType, XmlRootElement, XmlAccessorOrder, XmlSchema, XmlSchemaType, XmlSchemaTypes, , XmlJavaTypeAdapter. It can also be used with the following annotations at the package level: XmlJavaTypeAdapter.

Author:Sekhar Vajjhala, Sun Microsystems, Inc.
See Also:
Since:1.6, JAXB 2.0
/** * <p> Controls whether fields or Javabean properties are serialized by default. </p> * * <p> <b> Usage </b> </p> * * <p> {@code @XmlAccessorType} annotation can be used with the following program elements:</p> * * <ul> * <li> package</li> * <li> a top level class </li> * </ul> * * <p> See "Package Specification" in javax.xml.bind.package javadoc for * additional common information.</p> * * <p>This annotation provides control over the default serialization * of properties and fields in a class. * * <p>The annotation {@code @XmlAccessorType} on a package applies to * all classes in the package. The following inheritance * semantics apply: * * <ul> * <li> If there is a {@code @XmlAccessorType} on a class, then it * is used. </li> * <li> Otherwise, if a {@code @XmlAccessorType} exists on one of * its super classes, then it is inherited. * <li> Otherwise, the {@code @XmlAccessorType} on a package is * inherited. * </ul> * <p> <b> Defaulting Rules: </b> </p> * * <p>By default, if {@code @XmlAccessorType} on a package is absent, * then the following package level annotation is assumed.</p> * <pre> * &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) * </pre> * <p> By default, if {@code @XmlAccessorType} on a class is absent, * and none of its super classes is annotated with * {@code @XmlAccessorType}, then the following default on the class * is assumed: </p> * <pre> * &#64;XmlAccessorType(XmlAccessType.PUBLIC_MEMBER) * </pre> * <p>This annotation can be used with the following annotations: * {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorOrder}, * {@link XmlSchema}, {@link XmlSchemaType}, {@link XmlSchemaTypes}, * , {@link XmlJavaTypeAdapter}. It can also be used with the * following annotations at the package level: {@link XmlJavaTypeAdapter}. * * @author Sekhar Vajjhala, Sun Microsystems, Inc. * @since 1.6, JAXB 2.0 * @see XmlAccessType */
@Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE}) public @interface XmlAccessorType {
Specifies whether fields or properties are serialized.
See Also:
  • XmlAccessType
/** * Specifies whether fields or properties are serialized. * * @see XmlAccessType */
XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER; }