au.gov.nehta.common.utils

Class JaxbUtils

java.lang.Object

au.gov.nehta.common.utils.JaxbUtils

public final class JaxbUtils
extends Object

Utility class containing JAXB-related functions.

Constructor Summary

Constructors

Constructor and Description
JaxbUtils()

Method Summary

Modifier and Type	Method and Description
static void	marshal(JAXBElement<?> value, Writer output) Marshals a JAXBElement object into XML data to write to a character stream.
static Document	marshalToDom(JAXBElement<?> value) Marshals a JAXBElement object into a DOM document.
static String	marshalToString(JAXBElement<?> value) Marshals a JAXBElement object into a XML data string.
static <T> T	unmarshal(Node xmlNode, Class<T> jaxbClass) Unmarshals the XML data in a DOM node into a Java object using JAXB.
static <T> T	unmarshal(Reader reader, Class<T> jaxbClass) Unmarshals the XML data from a character stream into a Java object using JAXB.

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxbUtils

public JaxbUtils()

Method Detail

unmarshal

public static <T> T unmarshal(Node xmlNode,
                              Class<T> jaxbClass)
                       throws JAXBException

Unmarshals the XML data in a DOM node into a Java object using JAXB. This method simplifies the call to the method: javax.xml.bind.Unmarshaller#unmarshal(Source).

Type Parameters:

T - The type of class.

Parameters:

xmlNode - DOM node to read the XML data from. Cannot be null.

jaxbClass - JAXB-generated class that represents the XML data as a Java class. Cannot be null.

Returns:

Instance of type specified in the 'jaxbClass' containing data from the 'xmlNode'.

Throws:

JAXBException - Exception if any issues arise.

unmarshal

public static <T> T unmarshal(Reader reader,
                              Class<T> jaxbClass)
                       throws JAXBException

Unmarshals the XML data from a character stream into a Java object using JAXB. This method simplifies the call to the method: javax.xml.bind.Unmarshaller#unmarshal(Source).

Type Parameters:

T - The type of the class.

Parameters:

reader - Character stream to read the XML data from. Cannot be null.

jaxbClass - JAXB-generated class that represents the XML data as a Java class. Cannot be null.

Returns:

Instance of type specified in the 'jaxbClass' containing data from the 'xmlNode'.

Throws:

JAXBException - Exception if anything goes wrong.

marshal

public static void marshal(JAXBElement<?> value,
                           Writer output)
                    throws JAXBException,
                           IOException

Marshals a JAXBElement object into XML data to write to a character stream. This method simplifies the call to the method: javax.xml.bind.Marshaller#marshal(Object, Writer). A JAXBElement can be created from the ObjectFactory generated by JAXB for each package.

Parameters:

value - JAXBElement to marshal into XML data. Cannot be null.

output - Character stream to write to. Cannot be null.

Throws:

JAXBException - Exception if handling JAXBElement goes wrong.

IOException - Exception if problems with output.

marshalToString

public static String marshalToString(JAXBElement<?> value)
                              throws JAXBException

Marshals a JAXBElement object into a XML data string. This method simplifies the call to the method: javax.xml.bind.Marshaller#marshal(Object, Writer). A JAXBElement can be created from the ObjectFactory generated by JAXB for each package.

Parameters:

value - JAXBElement to marshal into XML data. Cannot be null.

Returns:

XML representation of the JAXBElement.

Throws:

JAXBException - Exception raised if handling JAXBElement goes wrong.

marshalToDom

public static Document marshalToDom(JAXBElement<?> value)
                             throws JAXBException,
                                    ParserConfigurationException

Marshals a JAXBElement object into a DOM document. This method simplifies the call to the method: javax.xml.bind.Marshaller#marshal(Object, Node). A JAXBElement can be created from the ObjectFactory generated by JAXB for each package.

Parameters:

value - JAXBElement to marshal into XML data. Cannot be null.

Returns:

XML DOM representation of the JAXBElement.

Throws:

JAXBException - Exception raised if handling JAXBElement goes wrong.

ParserConfigurationException - Exception if parser problems arise.