javax.xml.bind.annotation.XmlElement Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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
*
* @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,
* @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 {
* @XmlElement(name="itemprice")
* public java.math.BigDecimal price;
* }
*
* <!-- Example: Local XML Schema element -->
* <xs:complexType name="USPrice"/>
* <xs:sequence>
* <xs:element name="itemprice" type="xs:decimal" minOccurs="0"/>
* </sequence>
* </xs:complexType>
*
*
*
* Example 2: Map a field to a nillable element.
*
*
* //Example: Code fragment
* public class USPrice {
* @XmlElement(nillable=true)
* public java.math.BigDecimal price;
* }
*
* <!-- Example: Local XML Schema element -->
* <xs:complexType name="USPrice">
* <xs:sequence>
* <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="0"/>
* </sequence>
* </xs:complexType>
*
*
* Example 3: Map a field to a nillable, required element.
*
*
* //Example: Code fragment
* public class USPrice {
* @XmlElement(nillable=true, required=true)
* public java.math.BigDecimal price;
* }
*
* <!-- Example: Local XML Schema element -->
* <xs:complexType name="USPrice">
* <xs:sequence>
* <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="1"/>
* </sequence>
* </xs:complexType>
*
*
*
*
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 JAXB2.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:
*
* -
* 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.
*
*
-
* Otherwise '' (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 {}
}