com.peterphi.std.util.jaxb

Class JAXBSerialiser

java.lang.Object

com.peterphi.std.util.jaxb.JAXBSerialiser

public class JAXBSerialiser
extends java.lang.Object

A thread-safe, caching JAXB helper type. This wraps a JAXBContext and its Marshallers and Unmarshallers, allowing their concurrent use
This helper also translates the exceptions that can be thrown during a JAXB serialise/deserialise operation in a JAXBRuntimeException

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	deserialise(java.lang.Class<T> clazz, org.xml.sax.InputSource source) Deserialise an input and cast to a particular type
<T> T	deserialise(java.lang.Class<T> clazz, java.lang.String xml) Deserialise and cast to a particular type
java.lang.Object	deserialise(java.io.File file) Deserialise a File of XML to an Object (or JAXBElement)
java.lang.Object	deserialise(org.xml.sax.InputSource source)
java.lang.Object	deserialise(java.io.InputStream is) Deserialise a stream of XML to an Object (or JAXBElement)
java.lang.Object	deserialise(org.w3c.dom.Node node) Deserialise a DOM Node to an Object (or JAXBElement)
java.lang.Object	deserialise(java.io.Reader reader) Deserialise a Reader of XML to an Object (or JAXBElement)
java.lang.Object	deserialise(java.lang.String xml) Deserialise a String of XML to an Object (or JAXBElement)
javax.xml.bind.JAXBContext	getContext() Retrieve the inner JAXBContext NOTE: use of this method is strongly discouraged!
static JAXBSerialiser	getInstance(java.lang.Class<?>... classes) Helper method to get a JAXBSerialiser for a set of classes with the underlying JAXB implementation picked using the default rules for JAXB acquisition This is an expensive operation and so the result should ideally be cached
static JAXBSerialiser	getInstance(javax.xml.bind.JAXBContext context) Helper method to get a JAXBSerialiser from an existing JAXBContext. This is an expensive operation and so the result should ideally be cached
static JAXBSerialiser	getInstance(java.lang.String contextPath) Helper method to get a JAXBSerialiser from a JAXB Context Path (i.e.
static JAXBSerialiser	getMoxy(java.lang.Class<?>... classes) Helper method to get a JAXBSerialiser that uses EclipseLink MOXy for all operations
static JAXBSerialiser	getMoxy(java.lang.String contextPath) Helper method to get a JAXBSerialiser that uses EclipseLink MOXy for all operations
java.lang.String	serialise(java.lang.Object obj)
void	serialise(java.lang.Object obj, java.io.File file)
void	serialise(java.lang.Object obj, org.w3c.dom.Node node)
void	serialise(java.lang.Object obj, java.io.OutputStream os)
void	serialise(java.lang.Object obj, java.io.Writer writer)
org.w3c.dom.Document	serialiseToDocument(java.lang.Object obj) Helper method to serialise an Object to an org.w3c.dom.Document
JAXBSerialiser	setPrettyOutput(boolean pretty) Enable/Disable pretty printing
JAXBSerialiser	setSchema(javax.xml.validation.Schema schema) Optionally specify the schema to use for all future serialisation/deserialisation methods

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public javax.xml.bind.JAXBContext getContext()

Retrieve the inner JAXBContext
NOTE: use of this method is strongly discouraged!

Returns:

setSchema

public JAXBSerialiser setSchema(javax.xml.validation.Schema schema)

Optionally specify the schema to use for all future serialisation/deserialisation methods

Parameters:

schema -

Returns:

this for method chaining

setPrettyOutput

public JAXBSerialiser setPrettyOutput(boolean pretty)

Enable/Disable pretty printing

Parameters:

pretty -

Returns:

this for method chaining

deserialise

public java.lang.Object deserialise(java.lang.String xml)

Deserialise a String of XML to an Object (or JAXBElement)

Parameters:

xml -

Returns:

deserialise

public java.lang.Object deserialise(java.io.InputStream is)

Deserialise a stream of XML to an Object (or JAXBElement)

Parameters:

is -

Returns:

deserialise

public java.lang.Object deserialise(java.io.Reader reader)

Deserialise a Reader of XML to an Object (or JAXBElement)

Parameters:

reader -

Returns:

deserialise

public <T> T deserialise(java.lang.Class<T> clazz,
                org.xml.sax.InputSource source)

Deserialise an input and cast to a particular type

Parameters:

clazz -

source -

Returns:

deserialise

public <T> T deserialise(java.lang.Class<T> clazz,
                java.lang.String xml)

Deserialise and cast to a particular type

Parameters:

clazz -

xml - a String of XML

Returns:

deserialise

public java.lang.Object deserialise(java.io.File file)

Deserialise a File of XML to an Object (or JAXBElement)

Parameters:

file -

Returns:

deserialise

public java.lang.Object deserialise(org.xml.sax.InputSource source)

deserialise

public java.lang.Object deserialise(org.w3c.dom.Node node)

Deserialise a DOM Node to an Object (or JAXBElement)

Parameters:

node -

Returns:

serialiseToDocument

public org.w3c.dom.Document serialiseToDocument(java.lang.Object obj)

Helper method to serialise an Object to an org.w3c.dom.Document

Parameters:

obj - the object to serialise

Returns:

a new Document containing the serialised form of the provided Object

serialise

public java.lang.String serialise(java.lang.Object obj)

serialise

public void serialise(java.lang.Object obj,
             java.io.Writer writer)

serialise

public void serialise(java.lang.Object obj,
             java.io.OutputStream os)

serialise

public void serialise(java.lang.Object obj,
             java.io.File file)

serialise

public void serialise(java.lang.Object obj,
             org.w3c.dom.Node node)

getInstance

public static JAXBSerialiser getInstance(javax.xml.bind.JAXBContext context)

Helper method to get a JAXBSerialiser from an existing JAXBContext.
This is an expensive operation and so the result should ideally be cached

Parameters:

context - an existing JAXBContext

Returns:

getInstance

public static JAXBSerialiser getInstance(java.lang.Class<?>... classes)

Helper method to get a JAXBSerialiser for a set of classes with the underlying JAXB implementation picked using the default rules for JAXB acquisition
This is an expensive operation and so the result should ideally be cached

Parameters:

classes -

Returns:

getInstance

public static JAXBSerialiser getInstance(java.lang.String contextPath)

Helper method to get a JAXBSerialiser from a JAXB Context Path (i.e. a package name or colon-delimited list of package names) with the underlying JAXB implementation picked using the default rules for JAXB acquisition
This is an expensive operation and so the result should ideally be cached

Parameters:

contextPath - a package name or colon-delimited list of package names

Returns:

getMoxy

public static JAXBSerialiser getMoxy(java.lang.String contextPath)

Helper method to get a JAXBSerialiser that uses EclipseLink MOXy for all operations

Parameters:

contextPath -

Returns:

getMoxy

public static JAXBSerialiser getMoxy(java.lang.Class<?>... classes)

Helper method to get a JAXBSerialiser that uses EclipseLink MOXy for all operations

Parameters:

classes -

Returns: