uTools-Manuals/docs/java/javax/xml/bind/annotation/XmlElementWrapper.html

207 lines
9.2 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
javax.xml.bind.annotation
</div>
<h2 class="title" title="Annotation Type XmlElementWrapper">Annotation Type XmlElementWrapper</h2>
</div><div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr/> <br/> <pre><a href="../../../../java/lang/annotation/Retention.html" title="annotation in java.lang.annotation">@Retention</a>(<a href="../../../../java/lang/annotation/Retention.html#value--">value</a>=<a href="../../../../java/lang/annotation/RetentionPolicy.html#RUNTIME">RUNTIME</a>)
<a href="../../../../java/lang/annotation/Target.html" title="annotation in java.lang.annotation">@Target</a>(<a href="../../../../java/lang/annotation/Target.html#value--">value</a>={<a href="../../../../java/lang/annotation/ElementType.html#FIELD">字段</a>,<a href="../../../../java/lang/annotation/ElementType.html#METHOD">METHOD</a>})
public @interface <span class="memberNameLabel">XmlElementWrapper</span></pre>
<div class="block">
<span>围绕XML表示生成一个包装元素。</span>
<span>这主要用于生成围绕集合的包装XML元素。</span>
<span>因此,注释支持以下所示的两种形式的序列化。</span>
<pre> <span>//Example: code fragment
int[] names;
// XML Serialization Form 1 (Unwrapped collection)
&lt;names&gt; ... &lt;/names&gt;
&lt;names&gt; ... &lt;/names&gt;
// XML Serialization Form 2 ( Wrapped collection )
&lt;wrapperElement&gt;
&lt;names&gt; value-of-item &lt;/names&gt;
&lt;names&gt; value-of-item &lt;/names&gt;
....
&lt;/wrapperElement&gt;</span> </pre>
<p> <span>两个序列化XML表单允许通过缺少或存在具有nillable属性的元素来表示空集合。</span> </p>
<p> <span><b>用法</b></span> </p>
<p> <span><tt>@XmlElementWrapper</tt>注释可以与以下程序元素一起使用:</span> </p>
<ul>
<li> <span>JavaBean属性</span> </li>
<li> <span>非静态,非瞬态场</span> </li>
</ul>
<p> <span>用法受以下限制:</span> </p>
<ul>
<li> <span>该属性必须是集合属性</span> </li>
<li> <span>此注释可与以下注释一起使用: <a href="../../../../javax/xml/bind/annotation/XmlElement.html" title="javax.xml.bind.annotation中的注释"><code>XmlElement</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElements.html" title="javax.xml.bind.annotation中的注释"><code>XmlElements</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="javax.xml.bind.annotation中的注释"><code>XmlElementRef</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="javax.xml.bind.annotation中的注释"><code>XmlElementRefs</code></a> <a href="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html" title="javax.xml.bind.annotation.adapters中的注释"><code>XmlJavaTypeAdapter</code></a></span> </li>
</ul>
<p> <span>有关其他常见信息请参阅javax.xml.bind.package javadoc中的“Package Specification”。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
JAXB2.0
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../../../javax/xml/bind/annotation/XmlElement.html" title="javax.xml.bind.annotation中的注释"><code>XmlElement</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElements.html" title="javax.xml.bind.annotation中的注释"><code>XmlElements</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElementRef.html" title="javax.xml.bind.annotation中的注释"><code>XmlElementRef</code></a> <a href="../../../../javax/xml/bind/annotation/XmlElementRefs.html" title="javax.xml.bind.annotation中的注释"><code>XmlElementRefs</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- --> </a> <h3>Optional Element Summary</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption>
<span>Optional Elements</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#name--">name</a></span></code>
<div class="block">
XML包装元素的名称。
</div> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../java/lang/String.html" title="class in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#namespace--">namespace</a></span></code>
<div class="block">
XML包装器元素的XML目标命名空间。
</div> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#nillable--">nillable</a></span></code>
<div class="block">
如果为真,没有收集是通过使用
<tt>xsi:nil='true'</tt>表示。
</div> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/bind/annotation/XmlElementWrapper.html#required--">required</a></span></code>
<div class="block">
自定义包装器元素声明是必需的。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- --> </a> <h3>Element Detail</h3> <a name="name--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>name</h4> <pre>public abstract <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> name</pre>
<div class="block">
<span>XML包装元素的名称。</span>
<span>默认情况下XML包装器元素名称是从JavaBean属性名称派生的。</span>
</div>
<dl>
<dt>
Default:
</dt>
<dd>
“##默认”
</dd>
</dl> </li>
</ul> </li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="namespace--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>namespace</h4> <pre>public abstract <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> namespace</pre>
<div class="block">
<span>XML包装器元素的XML目标命名空间。</span>
<p> <span>如果值为“## default”则命名空间的确定如下</span> </p>
<ol>
<li> <span>如果封装封装有<a href="../../../../javax/xml/bind/annotation/XmlSchema.html" title="javax.xml.bind.annotation中的注释"><code>XmlSchema</code></a>注解,其<a href="../../../../javax/xml/bind/annotation/XmlSchema.html#elementFormDefault--"><code>elementFormDefault</code></a><a href="../../../../javax/xml/bind/annotation/XmlNsForm.html#QUALIFIED"><code>QUALIFIED</code></a> ,则为封闭类的命名空间。</span> </li>
<li> <span>否则“”(它在默认命名空间中产生不合格的元素。</span> </li>
</ol>
</div>
<dl>
<dt>
Default:
</dt>
<dd>
“##默认”
</dd>
</dl> </li>
</ul> </li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nillable--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>nillable</h4> <pre>public abstract boolean nillable</pre>
<div class="block">
<span>如果为真,则使用<tt>xsi:nil='true'</tt>表示不存在<tt>集合</tt></span>
<span>否则,它由缺少元素表示。</span>
</div>
<dl>
<dt>
Default:
</dt>
<dd>
</dd>
</dl> </li>
</ul> </li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="required--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>required</h4> <pre>public abstract boolean required</pre>
<div class="block">
<span>自定义包装器元素声明是必需的。</span>
<p> <span>如果required为true则相应的生成的XML模式元素声明将具有<tt>minOccurs="1"</tt> ,以指示包装器元素始终是预期的。</span> </p>
<p> <span>请注意,这仅影响模式生成,而不影响解组或编组功能。</span> <span>这只是让用户更好地表达应用程序约束的一种机制。</span> </p>
</div>
<dl>
<dt>
<span class="simpleTagLabel">从以下版本开始:</span>
</dt>
<dd>
JAXB 2.1
</dd>
</dl>
<dl>
<dt>
Default:
</dt>
<dd>
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>