AbstractListElementProvider (jersey-bundle 1.19.1 API)

java.lang.Object
- com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider<T>
- - com.sun.jersey.core.provider.jaxb.AbstractJAXBProvider<java.lang.Object>
  - - com.sun.jersey.core.provider.jaxb.AbstractListElementProvider

All Implemented Interfaces:

MessageBodyReader<java.lang.Object>, MessageBodyWriter<java.lang.Object>
```
public abstract class AbstractListElementProvider
extends AbstractJAXBProvider<java.lang.Object>
```
An abstract provider for T[], Collection<T>, and its subtypes as long as they have the public default constructor or are interfaces implemented by one the following classes:
- ArrayList
- LinkedList
- HashSet
- TreeSet
- Stack
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).
Author:

Paul.Sandoz@Sun.Com, Martin Matula

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AbstractListElementProvider.JaxbTypeChecker
This is to allow customized JAXB collections checking.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AbstractListElementProvider.JaxbTypeChecker` This is to allow customized JAXB collections checking.

Field Summary
- Fields inherited from class com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider
  UTF8

Constructor Summary

Constructors
Constructor and Description

AbstractListElementProvider(Providers ps)

AbstractListElementProvider(Providers ps, MediaType mt)

Constructors
Constructor and Description
`AbstractListElementProvider(Providers ps)`
`AbstractListElementProvider(Providers ps, MediaType mt)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected java.lang.Class`	`getElementClass(java.lang.Class<?> type, java.lang.reflect.Type genericType)`
`protected java.lang.String`	`getElementName(java.lang.Class<?> elementType)`
`protected java.lang.String`	`getRootElementName(java.lang.Class<?> elementType)`
`protected abstract javax.xml.stream.XMLStreamReader`	`getXMLStreamReader(java.lang.Class<?> elementType, MediaType mediaType, javax.xml.bind.Unmarshaller unmarshaller, java.io.InputStream entityStream)` Get the XMLStreamReader for unmarshalling.
`boolean`	`isReadable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType)` Ascertain if the MessageBodyReader can produce an instance of a particular type.
`boolean`	`isWriteable(java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType)` Ascertain if the MessageBodyWriter supports a particular type.
`java.lang.Object`	`readFrom(java.lang.Class<java.lang.Object> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.String> httpHeaders, java.io.InputStream entityStream)` Read a type from the `InputStream`.
`static boolean`	`verifyArrayType(java.lang.Class type, AbstractListElementProvider.JaxbTypeChecker checker)` The method could be used to check if given type is an array of JAXB beans.
`static boolean`	`verifyCollectionSubclass(java.lang.Class<?> type)`
`static boolean`	`verifyGenericType(java.lang.reflect.Type genericType, AbstractListElementProvider.JaxbTypeChecker checker)` The method could be used to check if given type is a collection of JAXB beans.
`abstract void`	`writeList(java.lang.Class<?> elementType, java.util.Collection<?> t, MediaType mediaType, java.nio.charset.Charset c, javax.xml.bind.Marshaller m, java.io.OutputStream entityStream)` Write a collection of JAXB objects as child elements of the root element.
`void`	`writeTo(java.lang.Object t, java.lang.Class<?> type, java.lang.reflect.Type genericType, java.lang.annotation.Annotation[] annotations, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders, java.io.OutputStream entityStream)` Write a type to an HTTP response.

Methods inherited from class com.sun.jersey.core.provider.jaxb.AbstractJAXBProvider
getJAXBContext, getMarshaller, getSAXSource, getStoredJAXBContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing, setConfiguration, setHeader

Methods inherited from class com.sun.jersey.core.provider.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

- Constructor Detail
  - AbstractListElementProvider
```
public AbstractListElementProvider(Providers ps)
```
  - AbstractListElementProvider
```
public AbstractListElementProvider(Providers ps,
                           MediaType mt)
```
- Method Detail
  - isReadable
```
public boolean isReadable(java.lang.Class<?> type,
                 java.lang.reflect.Type genericType,
                 java.lang.annotation.Annotation[] annotations,
                 MediaType mediaType)
```
    Description copied from interface: MessageBodyReader
    
    Ascertain if the MessageBodyReader can produce an instance of a particular type. The type parameter gives the class of the object that should be produced, the genericType parameter gives the java.lang.reflect.Type of the object that should be produced. E.g. if the object to be produced is List, the type parameter will be java.util.List and the genericType parameter will be java.lang.reflect.ParameterizedType.
    
    Parameters:
    type - the class of object to be produced.
    genericType - the type of object to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Method.getGenericParameterTypes.
    annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.
    mediaType - the media type of the HTTP entity, if one is not specified in the request then application/octet-stream is used.
    
    Returns:
    true if the type is supported, otherwise false.
  - isWriteable
```
public boolean isWriteable(java.lang.Class<?> type,
                  java.lang.reflect.Type genericType,
                  java.lang.annotation.Annotation[] annotations,
                  MediaType mediaType)
```
    Description copied from interface: MessageBodyWriter
    
    Ascertain if the MessageBodyWriter supports a particular type.
    
    Parameters:
    type - the class of object that is to be written.
    genericType - the type of object to be written, obtained either by reflection of a resource method return type or via inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
    annotations - an array of the annotations on the resource method that returns the object.
    mediaType - the media type of the HTTP entity.
    
    Returns:
    true if the type is supported, otherwise false.
  - verifyCollectionSubclass
```
public static boolean verifyCollectionSubclass(java.lang.Class<?> type)
```
  - verifyArrayType
```
public static boolean verifyArrayType(java.lang.Class type,
                      AbstractListElementProvider.JaxbTypeChecker checker)
```
    The method could be used to check if given type is an array of JAXB beans. It allows customizing the "is this a JAXB bean?" part.
    
    Parameters:
    type - the array to be checked
    checker - allows JAXB bean check customization
    
    Returns:
    true if given type is an array of JAXB beans
  - verifyGenericType
```
public static boolean verifyGenericType(java.lang.reflect.Type genericType,
                        AbstractListElementProvider.JaxbTypeChecker checker)
```
    The method could be used to check if given type is a collection of JAXB beans. It allows customizing the "is this a JAXB bean?" part.
    
    Parameters:
    genericType - the type to be checked
    checker - allows JAXB bean check customization
    
    Returns:
    true if given type is a collection of JAXB beans
  - writeTo
```
public final void writeTo(java.lang.Object t,
           java.lang.Class<?> type,
           java.lang.reflect.Type genericType,
           java.lang.annotation.Annotation[] annotations,
           MediaType mediaType,
           MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders,
           java.io.OutputStream entityStream)
                   throws java.io.IOException
```
    Description copied from interface: MessageBodyWriter
    
    Write a type to an HTTP response. The response header map is mutable but any changes must be made before writing to the output stream since the headers will be flushed prior to writing the response body.
    
    Parameters:
    t - the instance to write.
    type - the class of object that is to be written.
    genericType - the type of object to be written, obtained either by reflection of a resource method return type or by inspection of the returned instance. GenericEntity provides a way to specify this information at runtime.
    annotations - an array of the annotations on the resource method that returns the object.
    mediaType - the media type of the HTTP entity.
    httpHeaders - a mutable map of the HTTP response headers.
    entityStream - the OutputStream for the HTTP entity. The implementation should not close the output stream.
    
    Throws:
    
    java.io.IOException - if an IO error arises
  - writeList
```
public abstract void writeList(java.lang.Class<?> elementType,
             java.util.Collection<?> t,
             MediaType mediaType,
             java.nio.charset.Charset c,
             javax.xml.bind.Marshaller m,
             java.io.OutputStream entityStream)
                        throws javax.xml.bind.JAXBException,
                               java.io.IOException
```
    Write a collection of JAXB objects as child elements of the root element.
    
    Parameters:
    elementType - the element type in the collection.
    t - the collecton to marshall
    mediaType - the media type
    c - the charset
    m - the marshaller
    entityStream - the output stream to marshall the collection
    
    Throws:
    
    javax.xml.bind.JAXBException
    
    java.io.IOException
  - readFrom
```
public final java.lang.Object readFrom(java.lang.Class<java.lang.Object> type,
                        java.lang.reflect.Type genericType,
                        java.lang.annotation.Annotation[] annotations,
                        MediaType mediaType,
                        MultivaluedMap<java.lang.String,java.lang.String> httpHeaders,
                        java.io.InputStream entityStream)
                                throws java.io.IOException
```
    Description copied from interface: MessageBodyReader
    
    Read a type from the InputStream.
    
    Parameters:
    type - the type that is to be read from the entity stream.
    genericType - the type of object to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Method.getGenericParameterTypes.
    annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.
    mediaType - the media type of the HTTP entity.
    httpHeaders - the read-only HTTP headers associated with HTTP entity.
    entityStream - the InputStream of the HTTP entity. The caller is responsible for ensuring that the input stream ends when the entity has been consumed. The implementation should not close the input stream.
    
    Returns:
    the type that was read from the stream.
    
    Throws:
    
    java.io.IOException - if an IO error arises
  - getXMLStreamReader
```
protected abstract javax.xml.stream.XMLStreamReader getXMLStreamReader(java.lang.Class<?> elementType,
                                                  MediaType mediaType,
                                                  javax.xml.bind.Unmarshaller unmarshaller,
                                                  java.io.InputStream entityStream)
                                                                throws javax.xml.stream.XMLStreamException
```
    Get the XMLStreamReader for unmarshalling.
    
    Parameters:
    elementType - the individual element type.
    mediaType - the media type.
    unmarshaller - the unmarshaller as a carrier of possible config options.
    entityStream - the input stream.
    
    Returns:
    the XMLStreamReader.
    
    Throws:
    
    javax.xml.stream.XMLStreamException
  - getElementClass
```
protected java.lang.Class getElementClass(java.lang.Class<?> type,
                              java.lang.reflect.Type genericType)
```
  - getRootElementName
```
protected final java.lang.String getRootElementName(java.lang.Class<?> elementType)
```
  - getElementName
```
protected final java.lang.String getElementName(java.lang.Class<?> elementType)
```

Class AbstractListElementProvider

Nested Class Summary

Field Summary

Fields inherited from class com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider

Constructor Summary

Method Summary

Methods inherited from class com.sun.jersey.core.provider.jaxb.AbstractJAXBProvider

Methods inherited from class com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider

Methods inherited from class java.lang.Object

Constructor Detail

AbstractListElementProvider

AbstractListElementProvider

Method Detail

isReadable

isWriteable

verifyCollectionSubclass

verifyArrayType

verifyGenericType

writeTo

writeList

readFrom

getXMLStreamReader

getElementClass

getRootElementName

getElementName