javax.xml.bind.annotation.adapters.XmlAdapter Maven / Gradle / Ivy
Show all versions of jaxb-api-osgi Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
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:
*
*
* - XmlAdapter.marshal(...): During marshalling, JAXB
* binding framework invokes XmlAdapter.marshal(..) to adapt a
* bound type to value type, which is then marshaled to XML
* representation.
*
* - XmlAdapter.unmarshal(...): During unmarshalling,
* JAXB binding framework first unmarshals XML representation
* to a value type and then invokes XmlAdapter.unmarshal(..) to
* adapt the value type to a bound type.
*
*
* Writing an adapter therefore involves the following steps:
*
*
* - Write an adapter that implements this abstract class.
* - Install the adapter using the annotation {@link
* XmlJavaTypeAdapter}
*
*
* 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 - Sekhar Vajjhala, Sun Microsystems Inc.
- Kohsuke Kawaguchi, Sun Microsystems Inc.
* @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;
}