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

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

There is a newer version: 4.0.3
Show newest version
/*
 * Copyright (c) 2004, 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.Retention;
import java.lang.annotation.Target;

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

/**
 * Maps a JavaBean property to a XML element derived from property name.
 *
 * 

Usage *

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

    *
  • a JavaBean property
  • *
  • non static, non transient field
  • *
  • within {@link XmlElements} *
* * The usage is subject to the following constraints: *
    *
  • This annotation can be used with following annotations: * {@link XmlID}, * {@link XmlIDREF}, * {@link XmlList}, * {@link XmlSchemaType}, * {@link XmlValue}, * {@link XmlAttachmentRef}, * {@link XmlMimeType}, * {@link XmlInlineBinaryData}, * {@link XmlElementWrapper}, * {@link XmlJavaTypeAdapter}
  • *
  • if the type of JavaBean property is a collection type of * array, an indexed property, or a parameterized list, and * this annotation is used with {@link XmlElements} then, * {@code @XmlElement.type()} must be DEFAULT.class since the * collection item type is already known.
  • *
* *

* A JavaBean property, when annotated with @XmlElement annotation * is mapped to a local element in the XML Schema complex type to * which the containing class is mapped. * *

* Example 1: Map a public non static non final field to local * element *

 *     //Example: Code fragment
 *     public class USPrice {
 *        {@literal @}XmlElement(name="itemprice")
 *         public java.math.BigDecimal price;
 *     }
 * {@code
 *
 *     
 *     
 *       
 *         
 *       
 *     
 *   }
*

* * Example 2: Map a field to a nillable element. *

 *     //Example: Code fragment
 *     public class USPrice {
 *        {@literal @}XmlElement(nillable=true)
 *         public java.math.BigDecimal price;
 *     }
 * {@code
 *
 *     
 *     
 *       
 *         
 *       
 *     
 *   }
*

* Example 3: Map a field to a nillable, required element. *

 *     //Example: Code fragment
 *     public class USPrice {
 *        {@literal @}XmlElement(nillable=true, required=true)
 *         public java.math.BigDecimal price;
 *     }
 * {@code
 *
 *     
 *     
 *       
 *         
 *       
 *     
 *   }
* *

Example 4: Map a JavaBean property to an XML element * with anonymous type.

*

* See Example 6 in @{@link XmlType}. * * @author Sekhar Vajjhala, Sun Microsystems, Inc. * @since 1.6, JAXB 2.0 */ @Retention(RUNTIME) @Target({FIELD, METHOD, PARAMETER}) public @interface XmlElement { /** * Name of the XML Schema element. *

If the value is "##default", then element name is derived from the * JavaBean property name. */ String name() default "##default"; /** * Customize the element declaration to be nillable. *

If nillable() is true, then the JavaBean property is * mapped to a XML Schema nillable element declaration. */ boolean nillable() default false; /** * Customize the element declaration to be required. *

If required() is true, then Javabean property is mapped to * an XML schema element declaration with minOccurs="1". * maxOccurs is "1" for a single valued property and "unbounded" * for a multivalued property. *

If required() is false, then the Javabean property is mapped * to XML Schema element declaration with minOccurs="0". * maxOccurs is "1" for a single valued property and "unbounded" * for a multivalued property. */ boolean required() default false; /** * XML target namespace of the XML Schema element. *

* If the value is "##default", then the namespace is determined * as follows: *

    *
  1. * If the enclosing package has {@link XmlSchema} annotation, * and its {@link XmlSchema#elementFormDefault() elementFormDefault} * is {@link XmlNsForm#QUALIFIED QUALIFIED}, then the namespace of * the enclosing class. * *
  2. * Otherwise {@literal ''} (which produces unqualified element in the default * namespace. *
*/ String namespace() default "##default"; /** * Default value of this element. * *

* The

'\u0000'
value specified as a default of this annotation element * is used as a poor-man's substitute for null to allow implementations * to recognize the 'no default value' state. */ String defaultValue() default "\u0000"; /** * The Java class being referenced. */ Class type() default DEFAULT.class; /** * Used in {@link XmlElement#type()} to * signal that the type be inferred from the signature * of the property. */ static final class DEFAULT {} }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy