org.restlet.ext.jaxb
Class JaxbRepresentation<T>

java.lang.Object
  org.restlet.resource.Variant
      org.restlet.resource.Representation
          org.restlet.resource.StreamRepresentation
              org.restlet.resource.OutputRepresentation
                  org.restlet.resource.XmlRepresentation
                      org.restlet.ext.jaxb.JaxbRepresentation<T>

Type Parameters:

T - The type to wrap.

All Implemented Interfaces:

NamespaceContext

public class JaxbRepresentation<T>
extends XmlRepresentation

An XML representation based on JAXB that provides easy translation between XML and JAXB element class trees.

Author:

Overstock.com, Jerome Louvel

Field Summary

Fields inherited from class org.restlet.resource.Representation

UNKNOWN_SIZE

Constructor Summary

JaxbRepresentation(MediaType mediaType, T object)
Creates a JAXB representation from an existing JAXB content tree.

JaxbRepresentation(Representation xmlRepresentation, Class<T> type)
Creates a new JAXB representation, converting the input XML into a Java content tree.

JaxbRepresentation(Representation xmlRepresentation, Class<T> type, ValidationEventHandler validationHandler)
Creates a new JAXB representation, converting the input XML into a Java content tree.

JaxbRepresentation(Representation xmlRepresentation, String contextPath)
Creates a new JAXB representation, converting the input XML into a Java content tree.

JaxbRepresentation(Representation xmlRepresentation, String contextPath, ValidationEventHandler validationHandler)
Creates a new JAXB representation, converting the input XML into a Java content tree.

JaxbRepresentation(T object)
Creates a JAXB representation from an existing JAXB content tree with MediaType.APPLICATION_XML.

Method Summary

Object	evaluate(String expression, QName returnType)
String	getContextPath() Returns the list of Java package names that contain schema derived class and/or Java to schema (JAXB-annotated) mapped classes
T	getObject() Returns the wrapped Java object.
SAXSource	getSaxSource() Returns a JAXB SAX source.
ValidationEventHandler	getValidationEventHandler() Returns the optional validation event handler.
boolean	isFormattedOutput() Indicates if the resulting XML data should be formatted with line breaks and indentation.
void	setContextPath(String contextPath) Sets the list of Java package names that contain schema derived class and/or Java to schema (JAXB-annotated) mapped classes.
void	setFormattedOutput(boolean formattedOutput) Indicates if the resulting XML data should be formatted with line breaks and indentation.
void	setObject(T object) Sets the wrapped Java object.
void	write(OutputStream outputStream) Writes the representation to a byte stream.

Methods inherited from class org.restlet.resource.XmlRepresentation

getBoolean, getDocumentBuilder, getDomSource, getNamespaceURI, getNode, getNodes, getNumber, getPrefix, getPrefixes, getSaxSource, getStreamSource, getText, isNamespaceAware, putNamespace, release, setNamespaceAware, validate, validate, validate, validate

Methods inherited from class org.restlet.resource.OutputRepresentation

getStream

Methods inherited from class org.restlet.resource.StreamRepresentation

getChannel, getReader, write, write

Methods inherited from class org.restlet.resource.Representation

checkDigest, checkDigest, computeDigest, createEmpty, exhaust, getAvailableSize, getDigest, getDownloadName, getExpirationDate, getModificationDate, getRange, getSize, getTag, getText, isAvailable, isDownloadable, isTransient, setAvailable, setDigest, setDownloadable, setDownloadName, setExpirationDate, setModificationDate, setRange, setSize, setTag, setTransient

Methods inherited from class org.restlet.resource.Variant

getCharacterSet, getEncodings, getIdentifier, getLanguages, getMediaType, setCharacterSet, setEncodings, setIdentifier, setIdentifier, setLanguages, setMediaType

Methods inherited from class java.lang.Object

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

Constructor Detail

JaxbRepresentation

public JaxbRepresentation(MediaType mediaType,
                          T object)

Creates a JAXB representation from an existing JAXB content tree.

Parameters:

mediaType - The representation's media type.

object - The Java object.

JaxbRepresentation

public JaxbRepresentation(Representation xmlRepresentation,
                          Class<T> type)

Creates a new JAXB representation, converting the input XML into a Java content tree. The XML is validated.

Parameters:

xmlRepresentation - The XML wrapped in a representation.

type - The type to convert to.

Throws:

JAXBException - If the incoming XML does not validate against the schema.

IOException - If unmarshalling XML fails.

JaxbRepresentation

public JaxbRepresentation(Representation xmlRepresentation,
                          Class<T> type,
                          ValidationEventHandler validationHandler)

Creates a new JAXB representation, converting the input XML into a Java content tree. The XML is validated.

Parameters:

xmlRepresentation - The XML wrapped in a representation.

type - The type to convert to.

validationHandler - A handler for dealing with validation failures.

Throws:

JAXBException - If the incoming XML does not validate against the schema.

IOException - If unmarshalling XML fails.

JaxbRepresentation

public JaxbRepresentation(Representation xmlRepresentation,
                          String contextPath)

Creates a new JAXB representation, converting the input XML into a Java content tree. The XML is validated.

Parameters:

xmlRepresentation - The XML wrapped in a representation.

contextPath - The list of Java package names for JAXB.

Throws:

JAXBException - If the incoming XML does not validate against the schema.

IOException - If unmarshalling XML fails.

JaxbRepresentation

public JaxbRepresentation(Representation xmlRepresentation,
                          String contextPath,
                          ValidationEventHandler validationHandler)

Creates a new JAXB representation, converting the input XML into a Java content tree. The XML is validated.

Parameters:

xmlRepresentation - The XML wrapped in a representation.

contextPath - The list of Java package names for JAXB.

validationHandler - A handler for dealing with validation failures.

Throws:

JAXBException - If the incoming XML does not validate against the schema.

IOException - If unmarshalling XML fails.

JaxbRepresentation

public JaxbRepresentation(T object)

Creates a JAXB representation from an existing JAXB content tree with MediaType.APPLICATION_XML.

Parameters:

object - The Java object.

Method Detail

evaluate

public Object evaluate(String expression,
                       QName returnType)
                throws Exception

Specified by:

evaluate in class XmlRepresentation

Throws:

Exception

getContextPath

public String getContextPath()

Returns the list of Java package names that contain schema derived class and/or Java to schema (JAXB-annotated) mapped classes

Returns:

The list of Java package names.

getObject

public T getObject()
            throws IOException

Returns the wrapped Java object.

Returns:

The wrapped Java object.

Throws:

IOException

getSaxSource

public SAXSource getSaxSource()
                       throws IOException

Returns a JAXB SAX source.

Overrides:

getSaxSource in class XmlRepresentation

Returns:

A JAXB SAX source.

Throws:

IOException

getValidationEventHandler

public ValidationEventHandler getValidationEventHandler()

Returns the optional validation event handler.

Returns:

The optional validation event handler.

isFormattedOutput

public boolean isFormattedOutput()

Indicates if the resulting XML data should be formatted with line breaks and indentation. Defaults to false.

Returns:

the formattedOutput

setContextPath

public void setContextPath(String contextPath)

Sets the list of Java package names that contain schema derived class and/or Java to schema (JAXB-annotated) mapped classes.

Parameters:

contextPath - The JAXB context path.

setFormattedOutput

public void setFormattedOutput(boolean formattedOutput)

Indicates if the resulting XML data should be formatted with line breaks and indentation.

Parameters:

formattedOutput - True if the resulting XML data should be formatted.

setObject

public void setObject(T object)

Sets the wrapped Java object.

Parameters:

object - The Java object to set.

write

public void write(OutputStream outputStream)
           throws IOException

Writes the representation to a byte stream.

Specified by:

write in class Representation

Parameters:

outputStream - The output stream.

Throws:

IOException - If any error occurs attempting to write the stream.