XmlID (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：必需 | 可选

详细信息：元素

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

概述