public abstract class AbstractCollectionJaxbProvider extends AbstractJaxbProvider<Object>
T[]
, Collection<T>
,
and its subtypes as long as they have the public default constructor or
are interfaces implemented by one the following classes:
T
must be a JAXB type annotated with XmlRootElement
.
Implementing classes may extend this class to provide specific marshalling and unmarshalling behaviour.
When unmarshalling a UnmarshalException
will result in a
WebApplicationException
being thrown with a status of 400
(Client error), and a JAXBException
will result in a
WebApplicationException
being thrown with a status of 500
(Internal Server error).
When marshalling a JAXBException
will result in a
WebApplicationException
being thrown with a status of 500
(Internal Server error).
Modifier and Type | Class and Description |
---|---|
static interface |
AbstractCollectionJaxbProvider.JaxbTypeChecker
This is to allow customized JAXB collections checking.
|
UTF8
Constructor and Description |
---|
AbstractCollectionJaxbProvider(Providers ps,
Configuration config) |
AbstractCollectionJaxbProvider(Providers ps,
MediaType mt,
Configuration config) |
Modifier and Type | Method and Description |
---|---|
protected static Class |
getElementClass(Class<?> type,
Type genericType) |
protected static String |
getElementName(Class<?> elementType)
Get the element name for a given Java type.
|
protected String |
getRootElementName(Class<?> elementType)
Construct the name of the root element from it's Java type name.
|
protected abstract XMLStreamReader |
getXMLStreamReader(Class<?> elementType,
MediaType mediaType,
Unmarshaller unmarshaller,
InputStream entityStream)
Get the
XMLStreamReader for unmarshalling. |
boolean |
isReadable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType) |
boolean |
isWriteable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType) |
Object |
readFrom(Class<Object> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream inputStream) |
static boolean |
verifyArrayType(Class type,
AbstractCollectionJaxbProvider.JaxbTypeChecker checker)
The method could be used to check if given type is an array of JAXB beans.
|
static boolean |
verifyCollectionSubclass(Class<?> type) |
static boolean |
verifyGenericType(Type genericType,
AbstractCollectionJaxbProvider.JaxbTypeChecker checker)
The method could be used to check if given type is a collection of JAXB beans.
|
abstract void |
writeCollection(Class<?> elementType,
Collection<?> t,
MediaType mediaType,
Charset c,
Marshaller m,
OutputStream entityStream)
Write a collection of JAXB objects as child elements of the root element.
|
void |
writeTo(Object t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream) |
getMarshaller, getSAXSource, getStoredJaxbContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeader
getCharset, getSize, readFromAsString, writeTo, writeTo, writeToAsString
public AbstractCollectionJaxbProvider(Providers ps, Configuration config)
public AbstractCollectionJaxbProvider(Providers ps, MediaType mt, Configuration config)
public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
public static boolean verifyCollectionSubclass(Class<?> type)
public static boolean verifyArrayType(Class type, AbstractCollectionJaxbProvider.JaxbTypeChecker checker)
type
- the array to be checkedchecker
- allows JAXB bean check customizationpublic static boolean verifyGenericType(Type genericType, AbstractCollectionJaxbProvider.JaxbTypeChecker checker)
genericType
- the type to be checkedchecker
- allows JAXB bean check customizationpublic final void writeTo(Object t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException
IOException
public abstract void writeCollection(Class<?> elementType, Collection<?> t, MediaType mediaType, Charset c, Marshaller m, OutputStream entityStream) throws JAXBException, IOException
elementType
- the element type in the collection.t
- the collection to marshallmediaType
- the media typec
- the charsetm
- the marshallerentityStream
- the output stream to marshall the collectionJAXBException
- in case the marshalling of element collection fails.IOException
- in case of any other I/O error while marshalling the collection of JAXB objects.public final Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,String> httpHeaders, InputStream inputStream) throws IOException
IOException
protected abstract XMLStreamReader getXMLStreamReader(Class<?> elementType, MediaType mediaType, Unmarshaller unmarshaller, InputStream entityStream) throws XMLStreamException
XMLStreamReader
for unmarshalling.elementType
- the individual element type.mediaType
- the media type.unmarshaller
- the unmarshaller as a carrier of possible config options.entityStream
- the input stream.XMLStreamException
- in case XMLStreamReader
retrieval fails.protected final String getRootElementName(Class<?> elementType)
elementType
- element Java type.protected static String getElementName(Class<?> elementType)
In case the element is annotated with a XmlRootElement
annotation
and the specified element name
is not default,
the method returns the specified element name in the annotation. Otherwise, the method returns the name of
the element class instead.
elementType
- element Java type.Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.