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 でない非一時フィールド

追加の一般的な情報については、javax.xml.bind.package javadoc の「パッケージの仕様」を参照してください。

使用には次の制約があります。

• @XmlID で注釈できるのは、クラス内の最大 1 つのフィールドまたはプロパティーです。
• 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