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

javax.xml.bind.annotation.XmlAccessorOrder 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 the ordering of fields and properties in a class.

* *

Usage

* *

{@code @XmlAccessorOrder} annotation can be used with the following * program elements:

* *
    *
  • package
  • *
  • a top level class
  • *
* *

See "Package Specification" in {@code javax.xml.bind} package javadoc for * additional common information.

* *

The effective {@link XmlAccessOrder} on a class is determined * as follows: * *

    *
  • If there is a {@code @XmlAccessorOrder} on a class, then * it is used.
  • *
  • Otherwise, if a {@code @XmlAccessorOrder} exists on one of * its super classes, then it is inherited (by the virtue of * {@link Inherited}) *
  • Otherwise, the {@code @XmlAccessorOrder} on the package * of the class is used, if it's there. *
  • Otherwise {@link 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 1.6, JAXB 2.0 * @see XmlAccessOrder */ @Inherited @Retention(RUNTIME) @Target({PACKAGE, TYPE}) public @interface XmlAccessorOrder { XmlAccessOrder value() default XmlAccessOrder.UNDEFINED; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy