public abstract class XmlAdapter<ValueType,​BoundType>
extends ObjectSE

カスタムマーシャリング用に Java 型を適合させます。

使用法:

HashMap やその他の非 JavaBean クラスなど、一部の Java 型は XML 表現に自然にマップされません。逆に、XML 表現は Java 型にマップできますが、アプリケーションは別の Java 型を使用して XML 表現にアクセスすることを選択できます。例: スキーマから Java へのバインディングルールは、デフォルトで xs:DateTime を XmlGregorianCalendar にバインドします。ただし、アプリケーションは、xs:DateTime をカスタム型、たとえば MyXmlGregorianCalendar にバインドすることを望む場合があります。どちらの場合も、アプリケーションが XML コンテンツにアクセスするために使用するバインドされた型と XML 表現にマップされる値型の間に不一致があります。

この抽象クラスは、バインドされた型を値型に、またはその逆に適応させるためのメソッドを定義します。メソッドは、マーシャリングおよびアンマーシャリング中に Jakarta XML Binding バインディングフレームワークによって呼び出されます。

• XmlAdapter.marshal（...）: マーシャリング中に、Jakarta XML Binding バインディングフレームワークは XmlAdapter.marshal（..）を呼び出して、バインドされた型を値型に適合させ、XML 表現にマーシャリングします。
• XmlAdapter.unmarshal（...）: アンマーシャリング中に、Jakarta XML Binding バインディングフレームワークは最初に XML 表現を値型にアンマーシャリングし、次に XmlAdapter.unmarshal（..）を呼び出して値型をバインドされた型に適合させます。

アダプターの作成には次の手順が含まれます。

• この抽象クラスを実装するアダプターを作成します。
• アノテーション XmlJavaTypeAdapter を使用してアダプターをインストールします

例 : HashMap のカスタマイズされたマッピング

次の例は、@XmlAdapter と @XmlJavaTypeAdapter を使用して HashMap のマッピングをカスタマイズする方法を示しています。

ステップ 1: HashMap に必要な XML 表現を決定します。

     <hashmap>
         <entry key="id123">this is a value</entry>
         <entry key="id312">this is another value</entry>
         ...
     </hashmap>
 

ステップ 2: 上記の目的の XML 表現が従うべきスキーマ定義を決定します。

     
     <xs:complexType name="myHashMapType">
       <xs:sequence>
         <xs:element name="entry" type="myHashMapEntryType"
                        minOccurs = "0" maxOccurs="unbounded"/>
       </xs:sequence>
     </xs:complexType>

     <xs:complexType name="myHashMapEntryType">
       <xs:simpleContent>
         <xs:extension base="xs:string">
           <xs:attribute name="key" type="xs:int"/>
         </xs:extension>
       </xs:simpleContent>
     </xs:complexType>

 

ステップ 3: 上記のスキーマ定義を生成できる値型を記述します。

     public class MyHashMapType {
         List<MyHashMapEntryType> entry;
     }

     public class MyHashMapEntryType {
         @XmlAttribute
         public Integer key; 

         @XmlValue
         public String value;
     }
 

ステップ 4: 値型 MyHashMapType を、アプリケーションで使用されるバインドされた型 HashMap に適合させるアダプターを作成します。

     public final class MyHashMapAdapter extends
                        XmlAdapter<MyHashMapType,HashMap> { ... }
      
 

ステップ 5: アダプターを使用します。

     public class Foo {
         @XmlJavaTypeAdapter(MyHashMapAdapter.class)
         HashMap hashmap;
         ...
     }
 

上記のコードフラグメントは、次のスキーマにマップされます。

     <xs:complexType name="Foo">
       <xs:sequence>
         <xs:element name="hashmap" type="myHashMapType">
       </xs:sequence>
     </xs:complexType>