javax.xml.bind.annotation
註釋型別 XmlID

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface XmlID

將 JavaBean 屬性映射到 XML ID。

要在 XML 序列化然後反序列化這一過程中保持物件圖形的參考完整性，需要通過使用參考或容器適當地對物件參考進行編組。註釋 @XmlID 和 @XmlIDREF 一起使用時允許通過容器或參考來實作 JavaBean 屬性型別的自定義映射。

用法

@XmlID 註釋能夠與以下程序元素一起使用：

• JavaBean 屬性
• 非 static、非 transient 欄位

有關公共資訊，請參閱 javax.xml.bind.package javadoc 中的“套件規範”。

用法受到以下約束的限制：

• 只能使用 @XmlID 註釋一個類別中最多一個欄位或屬性。
• JavaBean 屬性的型別必須是 java.lang.String。
• 能夠與 @XmlID 一起使用的其他映射註釋只有 @XmlElement 和 @XmlAttribute。

範例：將 JavaBean 屬性的型別映射到 xs:ID

    // Example: code fragment
    public class Customer {
        @XmlAttribute
        @XmlID
        public String getCustomerID();
        public void setCustomerID(String id);
        .... other properties not shown 
    }

    <!-- Example: XML Schema fragment -->
    <xs:complexType name="Customer">
      <xs:complexContent>
        <xs:sequence>
          ....
        </xs:sequence>
        <xs:attribute name="customerID" type="xs:ID"/>
      </xs:complexContent>
    </xs:complexType>
 

從以下版本開始：

JAXB2.0

另請參見：

XmlIDREF