| <!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> |
| XmlMixed (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="XmlMixed (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/XmlMimeType.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../javax/xml/bind/annotation/XmlNs.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/XmlMixed.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XmlMixed.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 | OPTIONAL</FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: ELEMENT</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 XmlMixed</H2> |
| <HR> |
| <DL> |
| <DT><PRE><FONT SIZE="-1">@Retention(value=RUNTIME) |
| @Target(value={FIELD,METHOD}) |
| </FONT>public @interface <B>XmlMixed</B></DL> |
| </PRE> |
| |
| <P> |
| <p> |
| Annotate a JavaBean multi-valued property to support mixed content. |
| |
| <p> |
| The usage is subject to the following constraints: |
| <ul> |
| <li> can be used with @XmlElementRef, @XmlElementRefs or @XmlAnyElement</li> |
| </ul> |
| <p> |
| The following can be inserted into @XmlMixed annotated multi-valued property |
| <ul> |
| <li>XML text information items are added as values of java.lang.String.</li> |
| <li>Children element information items are added as instances of |
| <A HREF="../../../../javax/xml/bind/JAXBElement.html" title="class in javax.xml.bind"><CODE>JAXBElement</CODE></A> or instances with a class that is annotated with |
| @XmlRootElement.</li> |
| <li>Unknown content that is not be bound to a JAXB mapped class is inserted |
| as <CODE>Element</CODE>. (Assumes property annotated with @XmlAnyElement)</li> |
| </ul> |
| |
| Below is an example of binding and creation of mixed content. |
| <pre><xmp> |
| <!-- schema fragment having mixed content --> |
| <xs:complexType name="letterBody" mixed="true"> |
| <xs:sequence> |
| <xs:element name="name" type="xs:string"/> |
| <xs:element name="quantity" type="xs:positiveInteger"/> |
| <xs:element name="productName" type="xs:string"/> |
| <!-- etc. --> |
| </xs:sequence> |
| </xs:complexType> |
| <xs:element name="letterBody" type="letterBody"/> |
| |
| // Schema-derived Java code: |
| // (Only annotations relevant to mixed content are shown below, |
| // others are ommitted.) |
| import java.math.BigInteger; |
| public class ObjectFactory { |
| // element instance factories |
| JAXBElement<LetterBody> createLetterBody(LetterBody value); |
| JAXBElement<String> createLetterBodyName(String value); |
| JAXBElement<BigInteger> createLetterBodyQuantity(BigInteger value); |
| JAXBElement<String> createLetterBodyProductName(String value); |
| // type instance factory |
| LetterBody> createLetterBody(); |
| } |
| </xmp></pre> |
| <pre> |
| public class LetterBody { |
| // Mixed content can contain instances of Element classes |
| // Name, Quantity and ProductName. Text data is represented as |
| // java.util.String for text. |
| @XmlMixed |
| @XmlElementRefs({ |
| @XmlElementRef(name="productName", type=JAXBElement.class), |
| @XmlElementRef(name="quantity", type=JAXBElement.class), |
| @XmlElementRef(name="name", type=JAXBElement.class)}) |
| List getContent(){...} |
| } |
| </pre> |
| The following is an XML instance document with mixed content |
| <pre><xmp> |
| <letterBody> |
| Dear Mr.<name>Robert Smith</name> |
| Your order of <quantity>1</quantity> <productName>Baby |
| Monitor</productName> shipped from our warehouse. .... |
| </letterBody> |
| </xmp></pre> |
| that can be constructed using following JAXB API calls. |
| <pre><xmp> |
| LetterBody lb = ObjectFactory.createLetterBody(); |
| JAXBElement<LetterBody> lbe = ObjectFactory.createLetterBody(lb); |
| List gcl = lb.getContent(); //add mixed content to general content property. |
| gcl.add("Dear Mr."); // add text information item as a String. |
| |
| // add child element information item |
| gcl.add(ObjectFactory.createLetterBodyName("Robert Smith")); |
| gcl.add("Your order of "); // add text information item as a String |
| |
| // add children element information items |
| gcl.add(ObjectFactory. |
| createLetterBodyQuantity(new BigInteger("1"))); |
| gcl.add(ObjectFactory.createLetterBodyProductName("Baby Monitor")); |
| gcl.add("shipped from our warehouse"); // add text information item |
| </xmp></pre> |
| |
| <p>See "Package Specification" in javax.xml.bind.package javadoc for |
| additional common information.</p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Kohsuke Kawaguchi</DD> |
| <DT><B>Since:</B></DT> |
| <DD>JAXB2.0</DD> |
| </DL> |
| |
| <P> |
| |
| <P> |
| <!-- ========= 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/XmlMimeType.html" title="annotation in javax.xml.bind.annotation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../javax/xml/bind/annotation/XmlNs.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/XmlMixed.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="XmlMixed.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 | OPTIONAL</FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: ELEMENT</FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |