Top Description Inners Methods
javax.xml.bind.annotation

public @Interface XmlElement

extends Annotation
Annotations
@Retention:RUNTIME
@Target:FIELD, METHOD, PARAMETER
Imports
javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter, java.lang.annotation.Retention, .Target

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

Usage

@XmlElement annotation can be used with the following program elements:

The usage is subject to the following constraints:

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XmlElement.DEFAULT

Used in XmlElement#type() to signal that the type be inferred from the signature of the property.

Method Summary

Modifier and TypeMethod and Description
public String
defaultValue()

Default value of this element.

public String
name()

Name of the XML Schema element.

public String
namespace()

XML target namespace of the XML Schema element.

public boolean
nillable()

Customize the element declaration to be nillable.

public boolean
required()

Customize the element declaration to be required.

public Class<T>
type()

The Java class being referenced.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

defaultValueback to summary
public String defaultValue()

Default value of this element.

The

'\0'
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.
nameback to summary
public String name()

Name of the XML Schema element.

If the value is "##default", then element name is derived from the JavaBean property name.

namespaceback to summary
public String namespace()

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 XmlSchema annotation, and its elementFormDefault is QUALIFIED, then the namespace of the enclosing class.
  2. Otherwise '' (which produces unqualified element in the default namespace.
nillableback to summary
public boolean nillable()

Customize the element declaration to be nillable.

If nillable() is true, then the JavaBean property is mapped to a XML Schema nillable element declaration.

requiredback to summary
public 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.

typeback to summary
public Class<T> type()

The Java class being referenced.

javax.xml.bind.annotation back to summary

public final Class XmlElement.DEFAULT

extends Object
Class Inheritance

Used in XmlElement#type() to signal that the type be inferred from the signature of the property.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

DEFAULTback to summary
public DEFAULT()