mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-07-06 09:02:49 +08:00
273 lines
13 KiB
HTML
273 lines
13 KiB
HTML
<div class="header">
|
||
<div class="subTitle">
|
||
javax.xml.bind.annotation
|
||
</div>
|
||
<h2 class="title" title="Annotation Type XmlElement">Annotation Type XmlElement</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>,<a href="../../../../java/lang/annotation/ElementType.html#PARAMETER">PARAMETER</a>})
|
||
public @interface <span class="memberNameLabel">XmlElement</span></pre>
|
||
<div class="block">
|
||
<span>将JavaBean属性映射到从属性名称派生的XML元素。</span>
|
||
<p> <span><b>用法</b></span> </p>
|
||
<p> <span><tt>@XmlElement</tt>注释可以与以下程序元素一起使用：</span> </p>
|
||
<ul>
|
||
<li> <span>一个JavaBean属性</span> </li>
|
||
<li> <span>非静态，非瞬态场</span> </li>
|
||
<li> <span>在<a href="../../../../javax/xml/bind/annotation/XmlElements.html" title="javax.xml.bind.annotation中的注释"><code>XmlElements</code></a>内</span> <p></p></li>
|
||
</ul>
|
||
<span>用法受以下限制：</span>
|
||
<ul>
|
||
<li> <span>：此注释可以与以下注释一起使用<a href="../../../../javax/xml/bind/annotation/XmlID.html" title="javax.xml.bind.annotation中的注释"><code>XmlID</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlIDREF.html" title="javax.xml.bind.annotation中的注释"><code>XmlIDREF</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlList.html" title="javax.xml.bind.annotation中的注释"><code>XmlList</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlSchemaType.html" title="javax.xml.bind.annotation中的注释"><code>XmlSchemaType</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlValue.html" title="javax.xml.bind.annotation中的注释"><code>XmlValue</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlAttachmentRef.html" title="javax.xml.bind.annotation中的注释"><code>XmlAttachmentRef</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlMimeType.html" title="javax.xml.bind.annotation中的注释"><code>XmlMimeType</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlInlineBinaryData.html" title="javax.xml.bind.annotation中的注释"><code>XmlInlineBinaryData</code></a> ， <a href="../../../../javax/xml/bind/annotation/XmlElementWrapper.html" title="javax.xml.bind.annotation中的注释"><code>XmlElementWrapper</code></a> ， <a href="../../../../javax/xml/bind/annotation/adapters/XmlJavaTypeAdapter.html" title="javax.xml.bind.annotation.adapters中的注释"><code>XmlJavaTypeAdapter</code></a></span> </li>
|
||
<li> <span>如果JavaBean属性的类型是数组的集合类型，索引属性或参数化列表，并且此注释与<a href="../../../../javax/xml/bind/annotation/XmlElements.html" title="javax.xml.bind.annotation中的注释"><code>XmlElements</code></a>一起使用，则<tt>@XmlElement.type()</tt>必须为DEFAULT.class，因为集合项类型已知。</span> </li>
|
||
</ul>
|
||
<p> <span>当使用@XmlElement注释注释时，JavaBean属性将映射到包含类映射到的XML模式复合类型中的本地元素。</span> </p>
|
||
<p> <span><b>示例1：</b>将公共非静态非最终字段映射到本地元素</span> </p>
|
||
<pre> <span>//Example: Code fragment
|
||
public class USPrice {
|
||
@XmlElement(name="itemprice")
|
||
public java.math.BigDecimal price;
|
||
}
|
||
|
||
<!-- Example: Local XML Schema element -->
|
||
<xs:complexType name="USPrice"/>
|
||
<xs:sequence>
|
||
<xs:element name="itemprice" type="xs:decimal" minOccurs="0"/>
|
||
</sequence>
|
||
</xs:complexType></span> </pre>
|
||
<p> <span><b>示例2：</b>将字段映射到可填充元素。</span> </p>
|
||
<pre> <span>//Example: Code fragment
|
||
public class USPrice {
|
||
@XmlElement(nillable=true)
|
||
public java.math.BigDecimal price;
|
||
}
|
||
|
||
<!-- Example: Local XML Schema element -->
|
||
<xs:complexType name="USPrice">
|
||
<xs:sequence>
|
||
<xs:element name="price" type="xs:decimal" nillable="true" minOccurs="0"/>
|
||
</sequence>
|
||
</xs:complexType></span> </pre>
|
||
<p> <span><b>示例3：</b>将字段映射到可填充的必需元素。</span> </p>
|
||
<pre> <span>//Example: Code fragment
|
||
public class USPrice {
|
||
@XmlElement(nillable=true, required=true)
|
||
public java.math.BigDecimal price;
|
||
}
|
||
|
||
<!-- Example: Local XML Schema element -->
|
||
<xs:complexType name="USPrice">
|
||
<xs:sequence>
|
||
<xs:element name="price" type="xs:decimal" nillable="true" minOccurs="1"/>
|
||
</sequence>
|
||
</xs:complexType></span> </pre>
|
||
<p></p>
|
||
<p> <span><b>示例4：</b>将JavaBean属性映射到具有匿名类型的XML元素。</span> </p>
|
||
<p> <span>参见@ <a href="../../../../javax/xml/bind/annotation/XmlType.html" title="javax.xml.bind.annotation中的注释"><code>XmlType</code>中的</a>例6。</span> </p>
|
||
<p></p>
|
||
</div>
|
||
<dl>
|
||
<dt>
|
||
<span class="simpleTagLabel">从以下版本开始：</span>
|
||
</dt>
|
||
<dd>
|
||
JAXB2.0
|
||
</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/XmlElement.html#defaultValue--">defaultValue</a></span></code>
|
||
<div class="block">
|
||
该元素的默认值。
|
||
</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/XmlElement.html#name--">name</a></span></code>
|
||
<div class="block">
|
||
XML Schema元素的名称。
|
||
</div> </td>
|
||
</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/XmlElement.html#namespace--">namespace</a></span></code>
|
||
<div class="block">
|
||
XML Schema元素的XML目标命名空间。
|
||
</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/XmlElement.html#nillable--">nillable</a></span></code>
|
||
<div class="block">
|
||
自定义元素声明为nillable。
|
||
</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/XmlElement.html#required--">required</a></span></code>
|
||
<div class="block">
|
||
自定义元素声明是必需的。
|
||
</div> </td>
|
||
</tr>
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../../java/lang/Class.html" title="class in java.lang">类</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/bind/annotation/XmlElement.html#type--">type</a></span></code>
|
||
<div class="block">
|
||
Java类被引用。
|
||
</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 Schema元素的名称。</span>
|
||
<p> <span>如果值为“## default”，则元素名称将从JavaBean属性名称派生。</span> </p>
|
||
</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>自定义元素声明为nillable。</span>
|
||
<p> <span>如果nillable（）为true，则JavaBean属性将映射到XML Schema nillable元素声明。</span> </p>
|
||
</div>
|
||
<dl>
|
||
<dt>
|
||
Default:
|
||
</dt>
|
||
<dd>
|
||
假
|
||
</dd>
|
||
</dl> </li>
|
||
</ul> </li>
|
||
</ul>
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="required--">
|
||
<!-- --> </a>
|
||
<ul class="blockList">
|
||
<li class="blockList"> <h4>required</h4> <pre>public abstract boolean required</pre>
|
||
<div class="block">
|
||
<span>自定义元素声明是必需的。</span>
|
||
<p> <span>如果required（）为true，则Javabean属性将映射到具有minOccurs =“1”的XML模式元素声明。</span> <span>maxOccurs对于单值属性为“1”，对于多值属性为“无界”。</span> </p>
|
||
<p> <span>如果required（）为false，则Javabean属性将映射到具有minOccurs =“0”的XML Schema元素声明。</span> <span>maxOccurs对于单值属性为“1”，对于多值属性为“无界”。</span> </p>
|
||
</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 Schema元素的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="defaultValue--">
|
||
<!-- --> </a>
|
||
<ul class="blockList">
|
||
<li class="blockList"> <h4>defaultValue</h4> <pre>public abstract <a href="../../../../java/lang/String.html" title="class in java.lang">String</a> defaultValue</pre>
|
||
<div class="block">
|
||
<span>该元素的默认值。</span>
|
||
<p> <span>的</span> </p>
|
||
<pre> <span>''</span> </pre>
|
||
<span>被指定为该注释元素的默认值的值被用作穷人替代null以允许实现识别“无默认值”状态。</span>
|
||
</div>
|
||
<dl>
|
||
<dt>
|
||
Default:
|
||
</dt>
|
||
<dd>
|
||
“\ u0000”
|
||
</dd>
|
||
</dl> </li>
|
||
</ul> </li>
|
||
</ul>
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="type--">
|
||
<!-- --> </a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList"> <h4>type</h4> <pre>public abstract <a href="../../../../java/lang/Class.html" title="class in java.lang">类</a> type</pre>
|
||
<div class="block">
|
||
Java类被引用。
|
||
</div>
|
||
<dl>
|
||
<dt>
|
||
Default:
|
||
</dt>
|
||
<dd>
|
||
javax.xml.bind.annotation.XmlElement.DEFAULT.class
|
||
</dd>
|
||
</dl> </li>
|
||
</ul> </li>
|
||
</ul> </li>
|
||
</ul>
|
||
</div>
|
||
</div> |