189 lines
8.7 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 XmlAttribute">Annotation Type XmlAttribute</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">XmlAttribute</span></pre>
<div class="block">
<p> <span>将JavaBean属性映射到XML属性。</span> </p>
<p> <span><b>用法</b></span> </p>
<p> <span><tt>@XmlAttribute</tt>注释可以与以下程序元素一起使用:</span> </p>
<ul>
<li> <span>JavaBean属性</span> </li>
<li> <span>领域</span> </li>
</ul>
<p> <span>静态最终字段映射到XML固定属性。</span> </p>
<p> <span>有关其他常见信息请参阅javax.xml.bind.package javadoc中的“Package Specification”。</span> </p>
<span>用法受以下限制:</span>
<ul>
<li> <span>如果字段或属性的类型是集合类型,则集合项类型必须映射到模式简单类型。</span> <pre> <span>// Examples
@XmlAttribute List&lt;Integer&gt; items; //legal
@XmlAttribute List&lt;Bar&gt; foo; // illegal if Bar does not map to a schema simple type</span> </pre></li>
<li> <span>如果字段或属性的类型是非集合类型,则属性或字段的类型必须映射到简单的模式类型。</span> <pre> <span>// Examples
@XmlAttribute int foo; // legal
@XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type</span> </pre></li>
<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/adapters/XmlJavaTypeAdapter.html" title="javax.xml.bind.annotation.adapters中的注释"><code>XmlJavaTypeAdapter</code></a></span> </li>
</ul>
<p></p>
<p> <span><b>示例1</b>将JavaBean属性映射到XML属性。</span> </p>
<pre> <span>//Example: Code fragment
public class USPrice {
@XmlAttribute
public java.math.BigDecimal getPrice() {...} ;
public void setPrice(java.math.BigDecimal ) {...};
}
&lt;!-- Example: XML Schema fragment --&gt;
&lt;xs:complexType name="USPrice"&gt;
&lt;xs:sequence&gt;
&lt;/xs:sequence&gt;
&lt;xs:attribute name="price" type="xs:decimal"/&gt;
&lt;/xs:complexType&gt;</span> </pre>
<p> <span><b>示例2</b>将JavaBean属性映射到具有匿名类型的XML属性。</span> </p>
<span>参见@ <a href="../../../../javax/xml/bind/annotation/XmlType.html" title="javax.xml.bind.annotation中的注释"><code>XmlType</code>中的</a>例7。</span>
<p> <span><b>示例3</b>将JavaBean集合属性映射到XML属性。</span> </p>
<pre> <span>// Example: Code fragment
class Foo {
...
@XmlAttribute List&lt;Integer&gt; items;
}
&lt;!-- Example: XML Schema fragment --&gt;
&lt;xs:complexType name="foo"&gt;
...
&lt;xs:attribute name="items"&gt;
&lt;xs:simpleType&gt;
&lt;xs:list itemType="xs:int"/&gt;
&lt;/xs:simpleType&gt;
&lt;/xs:complexType&gt;</span> </pre>
</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/XmlType.html" title="javax.xml.bind.annotation中的注释"><code>XmlType</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/XmlAttribute.html#name--">name</a></span></code>
<div class="block">
XML Schema属性的名称。
</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/XmlAttribute.html#namespace--">namespace</a></span></code>
<div class="block">
指定XML Schema属性的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/XmlAttribute.html#required--">required</a></span></code>
<div class="block">
指定XML Schema属性是否为可选或必需。
</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>
<span>默认情况下XML Schema属性名称是从JavaBean属性名称派生的。</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="blockList">
<li class="blockList"> <h4>required</h4> <pre>public abstract boolean required</pre>
<div class="block">
<span>指定XML Schema属性是否为可选或必需。</span>
<span>如果为true则JavaBean属性将映射到所需的XML Schema属性。</span>
<span>否则它被映射到可选的XML模式属性。</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="blockListLast">
<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">
指定XML Schema属性的XML目标命名空间。
</div>
<dl>
<dt>
Default:
</dt>
<dd>
“##默认”
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>