diff -r 88b85470e72c -r f50545b5e2f1 src/share/jaxws_classes/javax/xml/bind/annotation/adapters/XmlAdapter.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/jaxws_classes/javax/xml/bind/annotation/adapters/XmlAdapter.java Tue Mar 06 16:09:35 2012 -0800 @@ -0,0 +1,193 @@ +/* + * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +package javax.xml.bind.annotation.adapters; + +/** + * Adapts a Java type for custom marshaling. + * + *

Usage:

+ * + *

+ * Some Java types do not map naturally to a XML representation, for + * example HashMap or other non JavaBean classes. Conversely, + * a XML repsentation may map to a Java type but an application may + * choose to accesss the XML representation using another Java + * type. For example, the schema to Java binding rules bind + * xs:DateTime by default to XmlGregorianCalendar. But an application + * may desire to bind xs:DateTime to a custom type, + * MyXmlGregorianCalendar, for example. In both cases, there is a + * mismatch between bound type , used by an application to + * access XML content and the value type, that is mapped to an + * XML representation. + * + *

+ * This abstract class defines methods for adapting a bound type to a value + * type or vice versa. The methods are invoked by the JAXB binding + * framework during marshaling and unmarshalling: + * + *

+ * + * Writing an adapter therefore involves the following steps: + * + * + * + *

Example: Customized mapping of HashMap

+ *

The following example illustrates the use of + * @XmlAdapter and @XmlJavaTypeAdapter to + * customize the mapping of a HashMap. + * + *

Step 1: Determine the desired XML representation for HashMap. + * + * 

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

Step 2: Determine the schema definition that the + * desired XML representation shown above should follow. + * + * 

+ *
+ *     <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>
+ *
+ *
+ * + *

Step 3: Write value types that can generate the above + * schema definition. + * + * 

+ *     public class MyHashMapType {
+ *         List<MyHashMapEntryType> entry;
+ *     }
+ *
+ *     public class MyHashMapEntryType {
+ *         @XmlAttribute
+ *         public Integer key;
+ *
+ *         @XmlValue
+ *         public String value;
+ *     }
+ *
+ * + *

Step 4: Write the adapter that adapts the value type, + * MyHashMapType to a bound type, HashMap, used by the application. + * + * 

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

Step 5: Use the adapter. + * + * 

+ *     public class Foo {
+ *         @XmlJavaTypeAdapter(MyHashMapAdapter.class)
+ *         HashMap hashmap;
+ *         ...
+ *     }
+ *
+ * + * The above code fragment will map to the following schema: + * + * 
+ *     <xs:complexType name="Foo">
+ *       <xs:sequence>
+ *         <xs:element name="hashmap" type="myHashMapType"
+ *       </xs:sequence>
+ *     </xs:complexType>
+ *
+ * + * @param + * The type that JAXB doesn't know how to handle. An adapter is written + * to allow this type to be used as an in-memory representation through + * the ValueType. + * @param + * The type that JAXB knows how to handle out of the box. + * + * @author + * @see XmlJavaTypeAdapter + * @since JAXB 2.0 + */ +public abstract class XmlAdapter { + + /** + * Do-nothing constructor for the derived classes. + */ + protected XmlAdapter() {} + + /** + * Convert a value type to a bound type. + * + * @param v + * The value to be converted. Can be null. + * @throws Exception + * if there's an error during the conversion. The caller is responsible for + * reporting the error to the user through {@link javax.xml.bind.ValidationEventHandler}. + */ + public abstract BoundType unmarshal(ValueType v) throws Exception; + + /** + * Convert a bound type to a value type. + * + * @param v + * The value to be convereted. Can be null. + * @throws Exception + * if there's an error during the conversion. The caller is responsible for + * reporting the error to the user through {@link javax.xml.bind.ValidationEventHandler}. + */ + public abstract ValueType marshal(BoundType v) throws Exception; +}