| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface annotation XmlElementWrapper extends Annotation
Generates 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:
See "Package Specification" in javax.xml.bind.package javadoc for additional common information.
Method Summary | |
---|---|
String |
name() Name of the XML wrapper element. |
String |
XML target namespace of the XML wrapper element. |
boolean |
nillable() If true, the absence of the collection is represented by using xsi:nil='true'. |
boolean |
required() Customize the wrapper element declaration to be required. |
Methods inherited from class java.lang.annotation.Annotation |
---|
annotationType, equals, hashCode, toString |
Method Detail |
---|
public String name()
public String namespace()
If the value is "##default", then the namespace is determined as follows:
public boolean nillable()
public boolean required()
If required() is true, then the corresponding generated XML schema element declaration will have minOccurs="1", to indicate that the wrapper element is always expected.
Note that this only affects the schema generation, and not the unmarshalling or marshalling capability. This is simply a mechanism to let users express their application constraints better.
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |