Package org.glassfish.jersey.jaxb.internal

Class XmlCollectionJaxbProvider

java.lang.Object

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

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

org.glassfish.jersey.jaxb.internal.AbstractCollectionJaxbProvider

org.glassfish.jersey.jaxb.internal.XmlCollectionJaxbProvider

All Implemented Interfaces:

jakarta.ws.rs.ext.MessageBodyReader<Object>, jakarta.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.

Author:

Paul Sandoz, Marek Potociar

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.glassfish.jersey.jaxb.internal.AbstractCollectionJaxbProvider

AbstractCollectionJaxbProvider.JaxbTypeChecker

Field Summary

Fields inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

UTF8

Method Summary

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

Methods inherited from class org.glassfish.jersey.jaxb.internal.AbstractCollectionJaxbProvider

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

Methods inherited from class org.glassfish.jersey.jaxb.internal.AbstractJaxbProvider

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

Methods inherited from class org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider

getCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsString

Methods inherited from class java.lang.Object

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

Method Detail

getXMLStreamReader

protected final XMLStreamReader getXMLStreamReader(Class<?> elementType,
                                                   jakarta.ws.rs.core.MediaType mediaType,
                                                   jakarta.xml.bind.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,
                                  jakarta.ws.rs.core.MediaType mediaType,
                                  Charset c,
                                  jakarta.xml.bind.Marshaller m,
                                  OutputStream entityStream)
                           throws jakarta.xml.bind.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:

jakarta.xml.bind.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.