Annotation Type XmlElement
-
@Retention(RUNTIME) @Target({FIELD,METHOD,PARAMETER}) public @interface XmlElementMaps a JavaBean property to a XML element derived from property name.Usage
@XmlElementannotation can be used with the following program elements:- a JavaBean property
- non static, non transient field
- within
XmlElements
- This annotation can be used with following annotations:
XmlID,XmlIDREF,XmlList,XmlSchemaType,XmlValue,XmlAttachmentRef,XmlMimeType,XmlInlineBinaryData,XmlElementWrapper,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
XmlElementsthen,@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 @
XmlType.- Author:
- Sekhar Vajjhala, Sun Microsystems, Inc.
- Since:
- 1.6, JAXB 2.0
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description java.lang.StringdefaultValueDefault value of this element.java.lang.StringnameName of the XML Schema element.java.lang.StringnamespaceXML target namespace of the XML Schema element.booleannillableCustomize the element declaration to be nillable.booleanrequiredCustomize the element declaration to be required.java.lang.ClasstypeThe Java class being referenced.
-
-
-
-
required
boolean required
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.
- Default:
- false
-
-
-
namespace
java.lang.String namespace
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
XmlSchemaannotation, and itselementFormDefaultisQUALIFIED, then the namespace of the enclosing class. - Otherwise '' (which produces unqualified element in the default namespace.
- Default:
- "##default"
-
If the enclosing package has
-
-