|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Target(value={FIELD,METHOD}) public @interface XmlElement
Maps a JavaBean property to a XML element derived from property name.
Usage
@XmlElement annotation can be used with the following program elements:
XmlElements
XmlID
,
XmlIDREF
,
XmlList
,
XmlSchemaType
,
XmlValue
,
XmlAttachmentRef
,
XmlMimeType
,
XmlInlineBinaryData
,
XmlJavaTypeAdapter
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"/> </sequence> </xs:complexType>
Example 2: Associate a global element with XML Schema type to which the class is mapped.
Note to Reviewers: Moved to XmlRootElement
Example 3: 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"/> </sequence> </xs:complexType>
Example 4: Map a JavaBean property to an XML element with anonymous type.
See Example 6 in @XmlType
.
Optional Element Summary | |
---|---|
java.lang.String |
defaultValue
Default value of this element. |
java.lang.String |
name
Name of the XML Schema element. |
java.lang.String |
namespace
Specifies the XML target namespace of the XML Schema element. |
boolean |
nillable
Customize the element declaration to be nillable. |
java.lang.Class |
type
The Java class being referenced. |
public abstract java.lang.String name
If the value is "##default", then element name is derived from the JavaBean property name.
public abstract boolean nillable
If nillable() is true, then the JavaBean property is mapped to a XML Schema nillable element declaration.
If nillable() is false and the JavaBean property type is a collection type, then the JavaBean property is mapped to repeating occurance.
Otherwise, the JavaBean property is mapped to an an XML Schema element declaration with occurance range of 0..1.
public abstract java.lang.String namespace
Specifies the XML target namespace of the XML Schema element.
If the value is "##default", then the namespace is the namespace of the containing class. Otherwise, it must be a valid namespace URI.
public abstract java.lang.String defaultValue
The '