org.josef.util.xml

Class XmlUtil

java.lang.Object

org.josef.util.xml.XmlUtil

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
public final class XmlUtil
extends Object

Xml related utility class.

Version:

1.0 $Revision: 5814 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
static String	marshal(JAXBContext jaxbContext, Object object) Marshals the supplied object into an XML string, using the supplied jaxbContext.
static String	marshal(MarshalParameters marshalParameters) Marshals an object to XML using the supplied marshalParameters.
static <T> T	unmarshal(JAXBContext jaxbContext, String xml, Class<T> type) Unmarshalls the supplied xml into an object of the supplied type, using the supplied jaxbContext.
static <T> T	unmarshal(UnmarshalParameters unmarshalParameters) Unmarshals XML into an object, where all necessary information is stored in the supplied unmarshalParameters.

Methods inherited from class java.lang.Object

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

Method Detail

marshal

public static String marshal(JAXBContext jaxbContext,
                             Object object)
                      throws JAXBException

Marshals the supplied object into an XML string, using the supplied jaxbContext.

Parameters:

jaxbContext - The JAXBContext used for marshalling or null to create a fresh JAXBContext.

object - The object to marshal.

Returns:

XML representation of the supplied object.

Throws:

JAXBException - When the supplied object could not be marshalled.

NullPointerException - When the supplied object is null.

marshal

public static String marshal(MarshalParameters marshalParameters)
                      throws JAXBException

Marshals an object to XML using the supplied marshalParameters.
Use this method instead of marshal(JAXBContext, Object) when you need more control over the marshalling process.

Parameters:

marshalParameters - The parameter object for the marshalling process.

Returns:

XML representation of the object.

Throws:

JAXBException - When the object could not be marshalled.

NullPointerException - When the supplied marshallParameters is null.

unmarshal

public static <T> T unmarshal(JAXBContext jaxbContext,
                              String xml,
                              Class<T> type)
                       throws JAXBException

Unmarshalls the supplied xml into an object of the supplied type, using the supplied jaxbContext.

Type Parameters:

T - The type of the object.

Parameters:

jaxbContext - The JAXBContext used for unmarshalling or null to create a fresh JAXBContext.

xml - The xml to unmarshal.

type - The type of the object.

Returns:

The object, created from the supplied xml.

Throws:

JAXBException - When the supplied xml could not be unmarshalled.

NullPointerException - When either the supplied xml or type is null.

IllegalArgumentException - When the supplied xml is empty.

unmarshal

public static <T> T unmarshal(UnmarshalParameters unmarshalParameters)
                       throws JAXBException

Unmarshals XML into an object, where all necessary information is stored in the supplied unmarshalParameters.

Type Parameters:

T - The type to unmarshal to.

Parameters:

unmarshalParameters - The parameter object for the unmarshalling process.

Returns:

The object, created as a result from the unmarshalling process.

Throws:

JAXBException - When the XML could not be unmarshalled.

NullPointerException - When the supplied unmarshalParameters is null.