|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT | |||||||||
@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface XmlElementWrapperGenerates a wrapper element around XML representation. This is primarily intended to be used to produce a wrapper XML element around collections. The annotation therefore supports two forms of serialization shown below.
//Example: code fragment
int[] names;
// XML Serialization Form 1 (Unwrapped collection)
<names> ... </names>
<names> ... </names>
// XML Serialization Form 2 ( Wrapped collection )
<wrapperElement>
<names> value-of-item </names>
<names> value-of-item </names>
....
</wrapperElement>
The two serialized XML forms allow a null collection to be represented either by absence or presence of an element with a nillable attribute.
Usage
The @XmlElementWrapper annotation can be used with the following program elements:
The usage is subject to the following constraints:
XmlElement,
XmlElements,
XmlElementRef,
XmlElementRefs,
XmlJavaTypeAdapterSee "Package Specification" in javax.xml.bind.package javadoc for additional common information.
XmlElement,
XmlElements,
XmlElementRef,
XmlElementRefs| Optional Element Summary | |
|---|---|
String |
name
Name of the XML wrapper element. |
String |
namespace
XML target namespace of the XML wrapper element. |
boolean |
nillable
If true, the absence of the collection is represented by using xsi:nil='true'. |
public abstract String name
public abstract String namespace
If the value is "##default", then the namespace is determined as follows:
XmlSchema annotation,
and its elementFormDefault
is QUALIFIED, then the namespace of
the enclosing class.
public abstract boolean nillable
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT | |||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.