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

<div class="header">
<div class="subTitle">
     javax.xml.bind.annotation 
   </div>
<h2 class="title" title="Annotation Type XmlID">Annotation Type XmlID</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">XmlID</span></pre>
<div class="block">
<p> <span>将JavaBean属性映射到XML ID。</span> </p>
<p> <span>为了保持XML序列化之后的XML反序列化对象图的引用完整性，需要通过引用或遏制来对对象引用进行编组。</span> <span>注释<tt>@XmlID</tt>和<tt>@XmlIDREF</tt>一起允许通过遏制或引用定制映射JavaBean属性的类型。</span> </p>
<p> <span><b>用法</b></span> </p>
<span><tt>@XmlID</tt>注释可以与以下程序元素一起使用：</span>
<ul>
<li> <span>一个JavaBean属性</span> </li>
<li> <span>非静态，非瞬态场</span> </li>
</ul>
<p> <span>有关其他常见信息，请参阅javax.xml.bind.package javadoc中的“Package Specification”。</span> </p>
<span>用法受以下限制：</span>
<ul>
<li> <span>在一个类中最多一个字段或属性可以与<tt>@XmlID</tt>进行注释。</span> </li>
<li> <span>JavaBean属性的类型必须为<tt>java.lang.String</tt> 。</span> </li>
<li> <span>可与<tt>@XmlID</tt>可以使用唯一的其他映射注释是<tt>：@XmlElement</tt>和<tt>@XmlAttribute。</tt></span> </li>
</ul>
<p> <span><b>示例</b> ：将JavaBean属性的类型映射到<tt>xs:ID</tt></span> </p>
<pre>  <span>// Example: code fragment
    public class Customer {
        @XmlAttribute
        @XmlID
        public String getCustomerID();
        public void setCustomerID(String id);
        .... other properties not shown
    }

    &lt;!-- Example: XML Schema fragment --&gt;
    &lt;xs:complexType name="Customer"&gt;
      &lt;xs:complexContent&gt;
        &lt;xs:sequence&gt;
          ....
        &lt;/xs:sequence&gt;
        &lt;xs:attribute name="customerID" type="xs:ID"/&gt;
      &lt;/xs:complexContent&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/XmlIDREF.html" title="javax.xml.bind.annotation中的注释"><code>XmlIDREF</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
</div>