api/3.0/jakarta/xml/bind/annotation/XmlMixed.html - gerrit/www.eclipse.org/eclipselink - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
 <title>XmlMixed (EclipseLink 3.0.0, API Reference)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2020-04-22">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
 <!--[if IE]>
 <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
 <![endif]-->
 <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
 <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="XmlMixed (EclipseLink 3.0.0, API Reference)";
         }
     }
     catch(err) {
     }
 //-->
 var pathtoroot = "../../../../";
 var useModuleDirectories = true;
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <ul class="navListSearch">
 <li><label for="search">SEARCH:</label>
 <input type="text" id="search" value="search" disabled="disabled">
 <input type="reset" id="reset" value="reset" disabled="disabled">
 </li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Required&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</li>
 </ul>
 </div>
 <a id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.xml.bind.annotation</a></div>
 <h2 title="Annotation Type XmlMixed" class="title">Annotation Type XmlMixed</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation" class="externalLink">RUNTIME</a>)
 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Target</a>({<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation" class="externalLink">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation" class="externalLink">METHOD</a>})
 public @interface <span class="memberNameLabel">XmlMixed</span></pre>
 <div class="block"><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 &#64;XmlElementRef, &#64;XmlElementRefs or &#64;XmlAnyElement</li>
  </ul>
  <p>
  The following can be inserted into &#64;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="../JAXBElement.html" title="class in jakarta.xml.bind"><code>JAXBElement</code></a> or instances with a class that is annotated with
  &#64;XmlRootElement.</li>
  <li>Unknown content that is not be bound to a JAXB mapped class is inserted
  as <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a>. (Assumes property annotated with &#64;XmlAnyElement)</li>
  </ul>

  Below is an example of binding and creation of mixed content.
  <pre><code>

   &lt;!-- schema fragment having  mixed content --&gt;
   &lt;xs:complexType name="letterBody" mixed="true"&gt;
     &lt;xs:sequence&gt;
 	&lt;xs:element name="name" type="xs:string"/&gt;
 	&lt;xs:element name="quantity" type="xs:positiveInteger"/&gt;
 	&lt;xs:element name="productName" type="xs:string"/&gt;
 	&lt;!-- etc. --&gt;
     &lt;/xs:sequence&gt;
   &lt;/xs:complexType&gt;
   &lt;xs:element name="letterBody" type="letterBody"/&gt;

  // Schema-derived Java code:
  // (Only annotations relevant to mixed content are shown below,
  //  others are omitted.)
  import java.math.BigInteger;
  public class ObjectFactory {
  	// element instance factories
  	JAXBElement&lt;LetterBody&gt; createLetterBody(LetterBody value);
  	JAXBElement&lt;String&gt;     createLetterBodyName(String value);
  	JAXBElement&lt;BigInteger&gt; createLetterBodyQuantity(BigInteger value);
  	JAXBElement&lt;String&gt;     createLetterBodyProductName(String value);
       // type instance factory
  	LetterBody createLetterBody();
  }
  </code></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.
         &#64;XmlMixed
         &#64;XmlElementRefs({
                 &#64;XmlElementRef(name="productName", type=JAXBElement.class),
                 &#64;XmlElementRef(name="quantity", type=JAXBElement.class),
                 &#64;XmlElementRef(name="name", type=JAXBElement.class)})
         List getContent(){...}
  }
  </pre>
  The following is an XML instance document with mixed content
  <pre><code>
  &lt;letterBody&gt;
  Dear Mr.&lt;name&gt;Robert Smith&lt;/name&gt;
  Your order of &lt;quantity&gt;1&lt;/quantity&gt; &lt;productName&gt;Baby
  Monitor&lt;/productName&gt; shipped from our warehouse. ....
  &lt;/letterBody&gt;
  </code></pre>
  that can be constructed using following JAXB API calls.
  <pre><code>
  LetterBody lb = ObjectFactory.createLetterBody();
  JAXBElement&lt;LetterBody&gt; 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
  </code></pre>

  <p>See "Package Specification" in jakarta.xml.bind.package javadoc for
  additional common information.</p></div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Kohsuke Kawaguchi</dd>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>1.6, JAXB 2.0</dd>
 </dl>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 <div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Required&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</li>
 </ul>
 </div>
 <a id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2017&#x2013;2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (11.0.2) on Wed Apr 22 10:19:16 CDT 2020 -->
	<title>XmlMixed (EclipseLink 3.0.0, API Reference)</title>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
	<meta name="dc.created" content="2020-04-22">
	<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
	<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
	<script type="text/javascript" src="../../../../script.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
	<!--[if IE]>
	<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
	<![endif]-->
	<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
	<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="XmlMixed (EclipseLink 3.0.0, API Reference)";
	}
	}
	catch(err) {
	}
	//-->
	var pathtoroot = "../../../../";
	var useModuleDirectories = true;
	loadScripts(document, 'script');</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<header role="banner">
	<nav role="navigation">
	<div class="fixedNav">
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a id="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-all.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	<div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
	</div>
	<div class="subNav">
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<ul class="navListSearch">
	<li><label for="search">SEARCH:</label>
	<input type="text" id="search" value="search" disabled="disabled">
	<input type="reset" id="reset" value="reset" disabled="disabled">
	</li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li>Required \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</li>
	</ul>
	</div>
	<a id="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	</div>
	<div class="navPadding"> </div>
	<script type="text/javascript"><!--
	$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
	//-->
	</script>
	</nav>
	</header>
	<!-- ======== START OF CLASS DATA ======== -->
	<main role="main">
	<div class="header">
	<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.xml.bind.annotation</a></div>
	<h2 title="Annotation Type XmlMixed" class="title">Annotation Type XmlMixed</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Retention</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation" class="externalLink">RUNTIME</a>)
	<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation" class="externalLink">@Target</a>({<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation" class="externalLink">FIELD</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation" class="externalLink">METHOD</a>})
	public @interface <span class="memberNameLabel">XmlMixed</span></pre>
	<div class="block"><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="../JAXBElement.html" title="class in jakarta.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 <a href="https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a>. (Assumes property annotated with @XmlAnyElement)</li>
	</ul>

	Below is an example of binding and creation of mixed content.
	<pre><code>

	<!-- 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 omitted.)
	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();
	}
	</code></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><code>
	<letterBody>
	Dear Mr.<name>Robert Smith</name>
	Your order of <quantity>1</quantity> <productName>Baby
	Monitor</productName> shipped from our warehouse. ....
	</letterBody>
	</code></pre>
	that can be constructed using following JAXB API calls.
	<pre><code>
	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
	</code></pre>

	<p>See "Package Specification" in jakarta.xml.bind.package javadoc for
	additional common information.</p></div>
	<dl>
	<dt><span class="simpleTagLabel">Author:</span></dt>
	<dd>Kohsuke Kawaguchi</dd>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>1.6, JAXB 2.0</dd>
	</dl>
	</li>
	</ul>
	</div>
	</div>
	</main>
	<!-- ========= END OF CLASS DATA ========= -->
	<footer role="contentinfo">
	<nav role="navigation">
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a id="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a id="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../../index.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../../index-all.html">Index</a></li>
	<li><a href="../../../../help-doc.html">Help</a></li>
	</ul>
	<div class="aboutLanguage">EclipseLink 3.0.0, API Reference</div>
	</div>
	<div class="subNav">
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../../allclasses.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li>Required \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</li>
	</ul>
	</div>
	<a id="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</nav>
	<p class="legalCopy"><small>Copyright © 2017–2020 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
	</footer>
	</body>
	</html>