Java EE 5 SDK

Annotation Type XmlElementWrapper

public @interface XmlElementWrapper

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 )
       <names> value-of-item </names>
       <names> value-of-item </names>

The two serialized XML forms allow a null collection to be represented either by absence or presence of an element with a nillable attribute.


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.

See Also:
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
Name of the XML wrapper element. By default, the XML wrapper element name is derived from the JavaBean property name.



public abstract String namespace
XML target namespace of the XML wrapper 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.



public abstract boolean nillable
If true, the absence of the collection is represented by using xsi:nil='true'. Otherwise, it is represented by the absence of the element.


Java EE 5 SDK

Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.

Scripting on this page tracks web page traffic, but does not change the content in any way.