All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.xml.bind.annotation.XmlAccessorType Maven / Gradle / Ivy

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 2005, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0, which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

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

* *

{@code @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 {@code @XmlAccessorType} on a package applies to * all classes in the package. The following inheritance * semantics apply: * *

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

Defaulting Rules:

* *

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

*
 *   @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
 * 
*

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:

*
 *   @XmlAccessorType(XmlAccessType.PUBLIC_MEMBER)
 * 
*

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 XmlAccessType */ XmlAccessType value() default XmlAccessType.PUBLIC_MEMBER; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy