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

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.AbstractRootElementProvider
              extended by com.sun.jersey.json.impl.provider.entity.JSONRootElementProvider
All Implemented Interfaces:
MessageBodyReader<Object>, MessageBodyWriter<Object>
Direct Known Subclasses:
JSONRootElementProvider.App, JSONRootElementProvider.General

public class JSONRootElementProvider
extends AbstractRootElementProvider

Author:
Paul.Sandoz@Sun.Com, Jakub.Podlesak@Sun.COM

Nested Class Summary
static class JSONRootElementProvider.App
           
static class JSONRootElementProvider.General
           
 
Field Summary
 
Fields inherited from class com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider
UTF8
 
Method Summary
 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.
protected  Object readFrom(Class<Object> type, MediaType mediaType, Unmarshaller u, InputStream entityStream)
          Unmarshal a JAXB type.
 void setConfiguration(FeaturesAndProperties fp)
           
protected  void writeTo(Object t, MediaType mediaType, Charset c, Marshaller m, OutputStream entityStream)
          Marshal an instance of a JAXB type.
 
Methods inherited from class com.sun.jersey.core.provider.jaxb.AbstractRootElementProvider
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 AbstractRootElementProvider
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 AbstractRootElementProvider
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.

readFrom

protected final Object readFrom(Class<Object> type,
                                MediaType mediaType,
                                Unmarshaller u,
                                InputStream entityStream)
                         throws JAXBException
Description copied from class: AbstractRootElementProvider
Unmarshal a JAXB type.

Implementing classes may override this method.

Overrides:
readFrom in class AbstractRootElementProvider
Parameters:
type - the JAXB type
mediaType - the media type
u - the unmarshaller to use for unmarshalling.
entityStream - the input stream to unmarshal from.
Returns:
an instance of the JAXB type.
Throws:
JAXBException

writeTo

protected void writeTo(Object t,
                       MediaType mediaType,
                       Charset c,
                       Marshaller m,
                       OutputStream entityStream)
                throws JAXBException
Description copied from class: AbstractRootElementProvider
Marshal an instance of a JAXB type.

Implementing classes may override this method.

Overrides:
writeTo in class AbstractRootElementProvider
Parameters:
t - the instance of the JAXB type.
mediaType - the meida type.
c - the character set to serialize characters to.
m - the marshaller to marshaller the instance of the JAXB type.
entityStream - the output stream to marshal to.
Throws:
JAXBException


Copyright © 2013 Oracle Corporation. All Rights Reserved.