javax.xml.bind.annotation.XmlAccessorOrder Maven / Gradle / Ivy
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
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 the ordering of fields and properties in a class.
*
* Usage
*
* @XmlAccessorOrder 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.
*
* The annotation @XmlAccessorOrder on a package applies to
* all classes in a package. The following inheritance semantics apply:
*
*
* - If there is a @XmlAccessorOrder on a class, then
* it is used.
* - Otherwise, if a @XmlAccessorOrder exists on one of
* its super classes, then it is inherited.
*
- Otherwise, the @XmlAccessorOrder on a package is
* inherited.
*
* Defaulting Rules:
*
* By default, if @XmlAccessorOrder on a package is absent,
* then the following package level annotation is assumed.
*
* @XmlAccessorType(XmlAccessOrder.UNDEFINED)
*
* By default, if @XmlAccessorOrder on a class is absent
* and none of super classes is annotated with XmlAccessorOrder
* , then the following default on the class is assumed:
*
* @XmlAccessorType(XmlAccessOrder.UNDEFINED)
*
* This annotation can be used with the following annotations:
* {@link XmlType}, {@link XmlRootElement}, {@link XmlAccessorType},
* {@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 JAXB2.0
* @version $Revision: 1.11 $
* @see XmlAccessOrder
*/
@Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE})
public @interface XmlAccessorOrder {
XmlAccessOrder value() default XmlAccessOrder.UNDEFINED;
}