javax.xml.bind.annotation.adapters

Class XmlAdapter<ValueType,BoundType>

java.lang.Object

javax.xml.bind.annotation.adapters.XmlAdapter<ValueType,BoundType>

参数类型

BoundType型JAXB不知道如何处理。一个适配器允许这种类型作为内存中的表示形式，通过 ValueType。

ValueType型JAXB知道如何处理开箱。

已知直接子类：

CollapsedStringAdapter， HexBinaryAdapter， NormalizedStringAdapter

public abstract class XmlAdapter<ValueType,BoundType>
extends Object

适应一个自定义封送处理java类型。

使用：

一些java类型不自然地映射到一个XML表示形式，例如HashMap或其他非JavaBean类。相反，一个XML表示可以映射到java类型，但应用可以访问使用另一个java类型的XML表示形式。例如，架构java绑定规则结合XS：日期默认XmlGregorianCalendar。但应用可能希望把XS：日期为自定义类型，例如MyXmlGregorianCalendar。在这两种情况下，有绑定类型之间的不匹配，通过应用程序访问XML内容和值类型使用，即映射到XML的表示。

这个抽象类定义了将绑定类型调整为值类型的方法，反之亦然。该方法是通过JAXB绑定编组和解组时，框架调用：

• 在XMLAdapter。元帅（…）：编组，JAXB绑定框架调用XMLAdapter。元帅（..）适应一种绑定类型的值类型，然后使用XML表示。
• XMLAdapter。解包（…）：在解包，JAXB绑定框架首先解封的XML表示为值类型，然后调用XMLAdapter。解包（..）适应值类型绑定类型。

写一个适配器，因此包括以下步骤：

• 写一个实现这个抽象类的适配器。
• 安装适配器使用注释XmlJavaTypeAdapter

例子:定制映射HashMap

下面举例说明@XmlAdapter和@XmlJavaTypeAdapter定制一个HashMap映射的使用。

步骤1：为HashMap确定所需的XML表示形式。

HashMap > <
 
        
        
        
      
        
      <输入键=“id123”>
       
         
       
         
         
         
  这是一个价值
  
         
         
         
       
         
       <进入> 
        <输入键=“id312”>
          这是另一个值 
         <进入>
           …< / HashMap > 
          
         
       
 
        
        
        
      
        
      

步骤2：确定架构定义所需的XML表示形式所示应遵循。

< xs：complexType名称=“myhashmaptype”>< xs：序列>< xs：元名称=“进入”type=“myhashmapentrytype”minOccurs =“0”=“maxOccurs无界”/>< / xs：序列>< / xs：名称>< xs：complexType名称=“myhashmapentrytype”>< xs：支持>< xs：扩展基地=“XS：字符串“>< xs：属性名=“钥匙”type=“XS：int”/>< / xs：扩展>< / xs：支持>< / xs：名称>

步骤3：写能产生上述架构定义的值类型。

公共课myhashmaptype {< myhashmapentrytype >条目列表；}公共课myhashmapentrytype {@ XmlAttribute公共整数键；@ XmlValue公共字符串值；}

步骤4：写适应值类型的适配器，MyHashMapType绑定类型，HashMap，由应用程序使用。

最后一类公共myhashmapadapter延伸XMLAdapter < myhashmaptype，HashMap > {…}

步骤5：使用适配器。

公共类Foo {“xmljavatypeadapter（myhashmapadapter。类）HashMap hashmap；…}

上面的代码片段会l图以下模式：

< xs：complexType名称=“foo”>< xs：序列>< xs：元名称=“=”myhashmaptype HashMap“型”< / xs：序列>< / xs：名称>

从以下版本开始：

JAXB 2

另请参见：

XmlJavaTypeAdapter

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	XmlAdapter() 无派生类的构造函数。

方法摘要

Modifier and Type	Method and Description
abstract ValueType	marshal(BoundType v) 将绑定类型转换为值类型。
abstract BoundType	unmarshal(ValueType v) 将值类型转换为绑定类型。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlAdapter

protected XmlAdapter()

无派生类的构造函数。

方法详细信息

unmarshal

public abstract BoundType unmarshal(ValueType v)
                             throws 异常

将值类型转换为绑定类型。

参数

v -要转换的值。可以为空。

异常

异常 -如果有一个错误在转换。调用者负责报告的错误通过 ValidationEventHandler用户。

marshal

public abstract ValueType marshal(BoundType v)
                           throws 异常

将绑定类型转换为值类型。

参数

v要convereted价值。可以为空。

异常

异常 -如果有一个错误在转换。调用者负责报告的错误通过 ValidationEventHandler用户。