api/1.2/javax/xml/bind/annotation/XmlElementWrapper.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--NewPage-->
 <HTML>
 <HEAD>
 <!-- Generated by javadoc (build 1.6.0) on Fri Oct 16 14:57:50 EDT 2009 -->
 <TITLE>
 XmlElementWrapper (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)
 </TITLE>

 <META NAME="date" CONTENT="2009-10-16">

 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

 <SCRIPT type="text/javascript">
 function windowTitle()
 {
     if (location.href.indexOf('is-external=true') == -1) {
         parent.document.title="XmlElementWrapper (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)";
     }
 }
 </SCRIPT>
 <NOSCRIPT>
 </NOSCRIPT>

 </HEAD>

 <BODY BGCOLOR="white" onload="windowTitle();">
 <HR>


 <!-- ========= START OF TOP NAVBAR ======= -->
 <A NAME="navbar_top"><!-- --></A>
 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_top_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../javax/xml/bind/annotation/XmlEnum.html" title="annotation in javax.xml.bind.annotation"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../index.html?javax/xml/bind/annotation/XmlElementWrapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="XmlElementWrapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
 <!-- ========= END OF TOP NAVBAR ========= -->

 <HR>
 <!-- ======== START OF CLASS DATA ======== -->
 <H2>
 <FONT SIZE="-1">
 javax.xml.bind.annotation</FONT>
 <BR>
 Annotation Type XmlElementWrapper</H2>
 <HR>
 <DL>
 <DT><PRE><FONT SIZE="-1">@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
 </FONT>public @interface <B>XmlElementWrapper</B></DL>
 </PRE>

 <P>
 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.

  <pre>
     //Example: code fragment
       int[] names;

     // XML Serialization Form 1 (Unwrapped collection)
     &lt;names> ... &lt;/names>
     &lt;names> ... &lt;/names>

     // XML Serialization Form 2 ( Wrapped collection )
     &lt;wrapperElement>
        &lt;names> value-of-item &lt;/names>
        &lt;names> value-of-item &lt;/names>
        ....
     &lt;/wrapperElement>
  </pre>

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

  <p> <b>Usage</b> </p>
  <p>
  The <tt>@XmlElementWrapper</tt> annotation can be used with the
  following program elements:
  <ul>
    <li> JavaBean property </li>
    <li> non static, non transient field </li>
  </ul>

  <p>The usage is subject to the following constraints:
  <ul>
    <li> The property must be a collection property </li>
    <li> This annotation can be used with the following annotations:
             <A HREF="../../../../javax/xml/bind/annotation/XmlElement.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElement</CODE></A>,
             <A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElements</CODE></A>,
             <A HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRef</CODE></A>,
             <A HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRefs</CODE></A>,
             <A HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html" title="annotation in javax.xml.bind.annotation.adapters"><CODE>XmlJavaTypeAdapter</CODE></A></li>.
  </ul>

  <p>See "Package Specification" in javax.xml.bind.package javadoc for
  additional common information.</p>
 <P>

 <P>
 <DL>
 <DT><B>See Also:</B><DD><A HREF="../../../../javax/xml/bind/annotation/XmlElement.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElement</CODE></A>,
 <A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElements</CODE></A>,
 <A HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRef</CODE></A>,
 <A HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRefs</CODE></A><DT><B>Author:</B></DT>
   <DD><ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul></DD>
 <DT><B>Since:</B></DT>
   <DD>JAXB2.0</DD>
 </DL>
 <HR>

 <P>
 <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->

 <A NAME="annotation_type_optional_element_summary"><!-- --></A>
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 <B>Optional Element Summary</B></FONT></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#name()">name</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name of the XML wrapper element.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#namespace()">namespace</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;XML target namespace of the XML wrapper element.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;boolean</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#nillable()">nillable</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the absence of the collection is represented by
  using <tt>xsi:nil='true'</tt>.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;boolean</CODE></FONT></TD>
 <TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#required()">required</A></B></CODE>

 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Customize the wrapper element declaration to be required.</TD>
 </TR>
 </TABLE>
 &nbsp;
 <P>
 <A NAME="name()"><!-- --></A><H3>
 name</H3>
 <PRE>
 public abstract java.lang.String <B>name</B></PRE>
 <DL>
 <DD>Name of the XML wrapper element. By default, the XML wrapper
  element name is derived from the JavaBean property name.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>"##default"</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="namespace()"><!-- --></A><H3>
 namespace</H3>
 <PRE>
 public abstract java.lang.String <B>namespace</B></PRE>
 <DL>
 <DD>XML target namespace of the XML wrapper element.
  <p>
  If the value is "##default", then the namespace is determined
  as follows:
  <ol>
   <li>
   If the enclosing package has <A HREF="../../../../javax/xml/bind/annotation/XmlSchema.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlSchema</CODE></A> annotation,
   and its <A HREF="../../../../javax/xml/bind/annotation/XmlSchema.html#elementFormDefault()"><CODE>elementFormDefault</CODE></A>
   is <A HREF="../../../../javax/xml/bind/annotation/XmlNsForm.html#QUALIFIED"><CODE>QUALIFIED</CODE></A>, then the namespace of
   the enclosing class.

   <li>
   Otherwise "" (which produces unqualified element in the default
   namespace.
  </ol>
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>"##default"</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="nillable()"><!-- --></A><H3>
 nillable</H3>
 <PRE>
 public abstract boolean <B>nillable</B></PRE>
 <DL>
 <DD>If true, the absence of the collection is represented by
  using <tt>xsi:nil='true'</tt>. Otherwise, it is represented by
  the absence of the element.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>false</DD>
 </DL>
 </DL>
 <HR>

 <A NAME="required()"><!-- --></A><H3>
 required</H3>
 <PRE>
 public abstract boolean <B>required</B></PRE>
 <DL>
 <DD>Customize the wrapper element declaration to be required.

  <p>
  If required() is true, then the corresponding generated
  XML schema element declaration will have <tt>minOccurs="1"</tt>,
  to indicate that the wrapper element is always expected.

  <p>
  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.
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
 <DT><B>Since:</B></DT>
   <DD>JAXB 2.1</DD>
 </DL>
 <DL>
 <DT><B>Default:</B><DD>false</DD>
 </DL>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
 <HR>


 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <A NAME="navbar_bottom"><!-- --></A>
 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 <TR>
 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 <A NAME="navbar_bottom_firstrow"><!-- --></A>
 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
   <TR ALIGN="center" VALIGN="top">
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
   </TR>
 </TABLE>
 </TD>
 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
 </TD>
 </TR>

 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 &nbsp;<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../../javax/xml/bind/annotation/XmlEnum.html" title="annotation in javax.xml.bind.annotation"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../../index.html?javax/xml/bind/annotation/XmlElementWrapper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 &nbsp;<A HREF="XmlElementWrapper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 &nbsp;<SCRIPT type="text/javascript">
   <!--
   if(window==top) {
     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
   }
   //-->
 </SCRIPT>
 <NOSCRIPT>
   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
 </NOSCRIPT>


 </FONT></TD>
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
   SUMMARY:&nbsp;REQUIRED&nbsp;|&nbsp;<A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 DETAIL:&nbsp;<A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_bottom"></A>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->

 <HR>

 </BODY>
 </HTML>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--NewPage-->
	<HTML>
	<HEAD>
	<!-- Generated by javadoc (build 1.6.0) on Fri Oct 16 14:57:50 EDT 2009 -->
	<TITLE>
	XmlElementWrapper (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)
	</TITLE>

	<META NAME="date" CONTENT="2009-10-16">

	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">

	<SCRIPT type="text/javascript">
	function windowTitle()
	{
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="XmlElementWrapper (EclipseLink 1.2.0, build 'v20091016-r5565' API Reference)";
	}
	}
	</SCRIPT>
	<NOSCRIPT>
	</NOSCRIPT>

	</HEAD>

	<BODY BGCOLOR="white" onload="windowTitle();">
	<HR>


	<!-- ========= START OF TOP NAVBAR ======= -->
	<A NAME="navbar_top"><!-- --></A>
	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_top_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A>
	<A HREF="../../../../javax/xml/bind/annotation/XmlEnum.html" title="annotation in javax.xml.bind.annotation"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?javax/xml/bind/annotation/XmlElementWrapper.html" target="_top"><B>FRAMES</B></A>
	<A HREF="XmlElementWrapper.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: REQUIRED \| <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_top"></A>
	<!-- ========= END OF TOP NAVBAR ========= -->

	<HR>
	<!-- ======== START OF CLASS DATA ======== -->
	<H2>
	<FONT SIZE="-1">
	javax.xml.bind.annotation</FONT>
	<BR>
	Annotation Type XmlElementWrapper</H2>
	<HR>
	<DL>
	<DT><PRE><FONT SIZE="-1">@Retention(value=RUNTIME)
	@Target(value={FIELD,METHOD})
	</FONT>public @interface <B>XmlElementWrapper</B></DL>
	</PRE>

	<P>
	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.

	<pre>
	//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>
	</pre>

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

	<p> <b>Usage</b> </p>
	<p>
	The <tt>@XmlElementWrapper</tt> annotation can be used with the
	following program elements:
	<ul>
	<li> JavaBean property </li>
	<li> non static, non transient field </li>
	</ul>

	<p>The usage is subject to the following constraints:
	<ul>
	<li> The property must be a collection property </li>
	<li> This annotation can be used with the following annotations:
	<A HREF="../../../../javax/xml/bind/annotation/XmlElement.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElement</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElements</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRef</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRefs</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html" title="annotation in javax.xml.bind.annotation.adapters"><CODE>XmlJavaTypeAdapter</CODE></A></li>.
	</ul>

	<p>See "Package Specification" in javax.xml.bind.package javadoc for
	additional common information.</p>
	<P>

	<P>
	<DL>
	<DT><B>See Also:</B><DD><A HREF="../../../../javax/xml/bind/annotation/XmlElement.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElement</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElements</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRef</CODE></A>,
	<A HREF="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlElementRefs</CODE></A><DT><B>Author:</B></DT>
	<DD><ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Sekhar Vajjhala, Sun Microsystems, Inc.</li></ul></DD>
	<DT><B>Since:</B></DT>
	<DD>JAXB2.0</DD>
	</DL>
	<HR>

	<P>
	<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->

	<A NAME="annotation_type_optional_element_summary"><!-- --></A>
	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
	<B>Optional Element Summary</B></FONT></TH>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#name()">name</A></B></CODE>

	<BR>
	Name of the XML wrapper element.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> java.lang.String</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#namespace()">namespace</A></B></CODE>

	<BR>
	XML target namespace of the XML wrapper element.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> boolean</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#nillable()">nillable</A></B></CODE>

	<BR>
	If true, the absence of the collection is represented by
	using <tt>xsi:nil='true'</tt>.</TD>
	</TR>
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
	<CODE> boolean</CODE></FONT></TD>
	<TD><CODE><B><A HREF="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#required()">required</A></B></CODE>

	<BR>
	Customize the wrapper element declaration to be required.</TD>
	</TR>
	</TABLE>

	<P>
	<A NAME="name()"><!-- --></A><H3>
	name</H3>
	<PRE>
	public abstract java.lang.String <B>name</B></PRE>
	<DL>
	<DD>Name of the XML wrapper element. By default, the XML wrapper
	element name is derived from the JavaBean property name.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>"##default"</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="namespace()"><!-- --></A><H3>
	namespace</H3>
	<PRE>
	public abstract java.lang.String <B>namespace</B></PRE>
	<DL>
	<DD>XML target namespace of the XML wrapper element.
	<p>
	If the value is "##default", then the namespace is determined
	as follows:
	<ol>
	<li>
	If the enclosing package has <A HREF="../../../../javax/xml/bind/annotation/XmlSchema.html" title="annotation in javax.xml.bind.annotation"><CODE>XmlSchema</CODE></A> annotation,
	and its <A HREF="../../../../javax/xml/bind/annotation/XmlSchema.html#elementFormDefault()"><CODE>elementFormDefault</CODE></A>
	is <A HREF="../../../../javax/xml/bind/annotation/XmlNsForm.html#QUALIFIED"><CODE>QUALIFIED</CODE></A>, then the namespace of
	the enclosing class.

	<li>
	Otherwise "" (which produces unqualified element in the default
	namespace.
	</ol>
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>"##default"</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="nillable()"><!-- --></A><H3>
	nillable</H3>
	<PRE>
	public abstract boolean <B>nillable</B></PRE>
	<DL>
	<DD>If true, the absence of the collection is represented by
	using <tt>xsi:nil='true'</tt>. Otherwise, it is represented by
	the absence of the element.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>false</DD>
	</DL>
	</DL>
	<HR>

	<A NAME="required()"><!-- --></A><H3>
	required</H3>
	<PRE>
	public abstract boolean <B>required</B></PRE>
	<DL>
	<DD>Customize the wrapper element declaration to be required.

	<p>
	If required() is true, then the corresponding generated
	XML schema element declaration will have <tt>minOccurs="1"</tt>,
	to indicate that the wrapper element is always expected.

	<p>
	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.
	<P>
	<DD><DL>
	</DL>
	</DD>
	<DD><DL>
	<DT><B>Since:</B></DT>
	<DD>JAXB 2.1</DD>
	</DL>
	<DL>
	<DT><B>Default:</B><DD>false</DD>
	</DL>
	</DL>
	<!-- ========= END OF CLASS DATA ========= -->
	<HR>


	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<A NAME="navbar_bottom"><!-- --></A>
	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
	<TR>
	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
	<A NAME="navbar_bottom_firstrow"><!-- --></A>
	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
	<TR ALIGN="center" VALIGN="top">
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
	</TR>
	</TABLE>
	</TD>
	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
	EclipseLink 1.2.0, build 'v20091016-r5565' API Reference</EM>
	</TD>
	</TR>

	<TR>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../javax/xml/bind/annotation/XmlElements.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A>
	<A HREF="../../../../javax/xml/bind/annotation/XmlEnum.html" title="annotation in javax.xml.bind.annotation"><B>NEXT CLASS</B></A></FONT></TD>
	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
	<A HREF="../../../../index.html?javax/xml/bind/annotation/XmlElementWrapper.html" target="_top"><B>FRAMES</B></A>
	<A HREF="XmlElementWrapper.html" target="_top"><B>NO FRAMES</B></A>
	<SCRIPT type="text/javascript">
	<!--
	if(window==top) {
	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
	}
	//-->
	</SCRIPT>
	<NOSCRIPT>
	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
	</NOSCRIPT>


	</FONT></TD>
	</TR>
	<TR>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	SUMMARY: REQUIRED \| <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
	DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
	</TR>
	</TABLE>
	<A NAME="skip-navbar_bottom"></A>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->

	<HR>

	</BODY>
	</HTML>