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