com.sun.jersey.json.impl.provider.entity
Class JSONListElementProvider

java.lang.Object
  extended by com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider<T>
      extended by com.sun.jersey.core.provider.jaxb.AbstractJAXBProvider<Object>
          extended by com.sun.jersey.core.provider.jaxb.AbstractListElementProvider
              extended by com.sun.jersey.json.impl.provider.entity.JSONListElementProvider
All Implemented Interfaces:
MessageBodyReader<Object>, MessageBodyWriter<Object>
Direct Known Subclasses:
JSONListElementProvider.App, JSONListElementProvider.General

public class JSONListElementProvider
extends AbstractListElementProvider

Author:
Jakub.Podlesak@Sun.COM

Nested Class Summary
static class JSONListElementProvider.App
           
static class JSONListElementProvider.General
           
 
Field Summary
 
Fields inherited from class com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider
UTF8
 
Method Summary
protected  XMLStreamReader getXMLStreamReader(Class<?> elementType, MediaType mediaType, Unmarshaller u, InputStream entityStream)
          Get the XMLStreamReader for unmarshalling.
 boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
          Ascertain if the MessageBodyReader can produce an instance of a particular type.
 boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
          Ascertain if the MessageBodyWriter supports a particular type.
 void setConfiguration(FeaturesAndProperties fp)
           
 void writeList(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.
 
Methods inherited from class com.sun.jersey.core.provider.jaxb.AbstractListElementProvider
getElementClass, getRootElementName, readFrom, writeTo
 
Methods inherited from class com.sun.jersey.core.provider.jaxb.AbstractJAXBProvider
getMarshaller, getSAXSource, getStoredJAXBContext, getUnmarshaller, isFormattedOutput, isSupported, isXmlRootElementProcessing
 
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
 

Method Detail

setConfiguration

@Context
public void setConfiguration(FeaturesAndProperties fp)
Overrides:
setConfiguration in class AbstractJAXBProvider<Object>

isReadable

public boolean isReadable(Class<?> type,
                          Type genericType,
                          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.

Specified by:
isReadable in interface MessageBodyReader<Object>
Overrides:
isReadable in class AbstractListElementProvider
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(Class<?> type,
                           Type genericType,
                           Annotation[] annotations,
                           MediaType mediaType)
Description copied from interface: MessageBodyWriter
Ascertain if the MessageBodyWriter supports a particular type.

Specified by:
isWriteable in interface MessageBodyWriter<Object>
Overrides:
isWriteable in class AbstractListElementProvider
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.

writeList

public final void writeList(Class<?> elementType,
                            Collection<?> t,
                            MediaType mediaType,
                            Charset c,
                            Marshaller m,
                            OutputStream entityStream)
                     throws JAXBException,
                            IOException
Description copied from class: AbstractListElementProvider
Write a collection of JAXB objects as child elements of the root element.

Specified by:
writeList in class AbstractListElementProvider
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:
JAXBException
IOException

getXMLStreamReader

protected final XMLStreamReader getXMLStreamReader(Class<?> elementType,
                                                   MediaType mediaType,
                                                   Unmarshaller u,
                                                   InputStream entityStream)
                                            throws XMLStreamException
Description copied from class: AbstractListElementProvider
Get the XMLStreamReader for unmarshalling.

Specified by:
getXMLStreamReader in class AbstractListElementProvider
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


Copyright © 2013 Oracle Corporation. All Rights Reserved.