Class XmlCollectionJaxbProvider

java.lang.Object

org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider<Object>

org.glassfish.jersey.jaxb.internal.AbstractJaxbProvider<Object>

org.glassfish.jersey.jaxb.internal.AbstractCollectionJaxbProvider

org.glassfish.jersey.jaxb.internal.XmlCollectionJaxbProvider

All Implemented Interfaces:

javax.ws.rs.ext.MessageBodyReader<Object>, javax.ws.rs.ext.MessageBodyWriter<Object>

Direct Known Subclasses:

XmlCollectionJaxbProvider.App, XmlCollectionJaxbProvider.General, XmlCollectionJaxbProvider.Text

public abstract class XmlCollectionJaxbProvider
extends AbstractCollectionJaxbProvider

Base XML-based message body provider for collections of JAXB beans.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	XmlCollectionJaxbProvider.App	JAXB provider for marshalling/un-marshalling collections from/to entities of application/xml media type.
static final class	XmlCollectionJaxbProvider.General	JAXB provider for marshalling/un-marshalling collections from/to entities of <type>/<sub-type>+xml media types.
static final class	XmlCollectionJaxbProvider.Text	JAXB provider for marshalling/un-marshalling collections from/to entities of text/xml media type.

Nested classes/interfaces inherited from class AbstractCollectionJaxbProvider

AbstractCollectionJaxbProvider.JaxbTypeChecker

Field Summary

Fields

Modifier and Type	Field	Description
private final javax.inject.Provider<XMLInputFactory>	xif

Fields inherited from class AbstractMessageReaderWriterProvider

UTF8

Constructor Summary

Constructors

Constructor	Description
XmlCollectionJaxbProvider(javax.inject.Provider<XMLInputFactory> xif, javax.ws.rs.ext.Providers ps)
XmlCollectionJaxbProvider(javax.inject.Provider<XMLInputFactory> xif, javax.ws.rs.ext.Providers ps, javax.ws.rs.core.MediaType mt)

Method Summary

Modifier and Type	Method	Description
protected final XMLStreamReader	getXMLStreamReader(Class<?> elementType, javax.ws.rs.core.MediaType mediaType, Unmarshaller u, InputStream entityStream)	Get the XMLStreamReader for unmarshalling.
final void	writeCollection(Class<?> elementType, Collection<?> t, javax.ws.rs.core.MediaType mediaType, Charset c, Marshaller m, OutputStream entityStream)	Write a collection of JAXB objects as child elements of the root element.

Methods inherited from class AbstractCollectionJaxbProvider

getElementClass, getElementName, getRootElementName, isReadable, isWriteable, readFrom, verifyArrayType, verifyCollectionSubclass, verifyGenericType, writeTo

Methods inherited from class AbstractJaxbProvider

getMarshaller, getSAXSource, getStoredJaxbContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeader

Methods inherited from class AbstractMessageReaderWriterProvider

getCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsString

Methods inherited from class Object

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

Field Details

xif

private final javax.inject.Provider<XMLInputFactory> xif

Constructor Details

XmlCollectionJaxbProvider

XmlCollectionJaxbProvider(javax.inject.Provider<XMLInputFactory> xif,
 javax.ws.rs.ext.Providers ps)

XmlCollectionJaxbProvider

XmlCollectionJaxbProvider(javax.inject.Provider<XMLInputFactory> xif,
 javax.ws.rs.ext.Providers ps,
 javax.ws.rs.core.MediaType mt)

Method Details

getXMLStreamReader

protected final XMLStreamReader getXMLStreamReader(Class<?> elementType,
 javax.ws.rs.core.MediaType mediaType,
 Unmarshaller u,
 InputStream entityStream)
                                            throws XMLStreamException

Description copied from class: AbstractCollectionJaxbProvider

Get the XMLStreamReader for unmarshalling.

Specified by:

getXMLStreamReader in class AbstractCollectionJaxbProvider

Parameters:

elementType - the individual element type.

mediaType - the media type.

u - the unmarshaller as a carrier of possible config options.

entityStream - the input stream.

Returns:

the XMLStreamReader.

Throws:

XMLStreamException - in case XMLStreamReader retrieval fails.

writeCollection

public final void writeCollection(Class<?> elementType,
 Collection<?> t,
 javax.ws.rs.core.MediaType mediaType,
 Charset c,
 Marshaller m,
 OutputStream entityStream)
                           throws JAXBException,
IOException

Description copied from class: AbstractCollectionJaxbProvider

Write a collection of JAXB objects as child elements of the root element.

Specified by:

writeCollection in class AbstractCollectionJaxbProvider

Parameters:

elementType - the element type in the collection.

t - the collection to marshall

mediaType - the media type

c - the charset

m - the marshaller

entityStream - the output stream to marshall the collection

Throws:

JAXBException - in case the marshalling of element collection fails.

IOException - in case of any other I/O error while marshalling the collection of JAXB objects.