com.sun.jersey.json.impl.provider.entity
Class JSONWithPaddingProvider
java.lang.Object
com.sun.jersey.core.provider.AbstractMessageReaderWriterProvider<JSONWithPadding>
com.sun.jersey.json.impl.provider.entity.JSONWithPaddingProvider
- All Implemented Interfaces:
- MessageBodyReader<JSONWithPadding>, MessageBodyWriter<JSONWithPadding>
public class JSONWithPaddingProvider
- extends AbstractMessageReaderWriterProvider<JSONWithPadding>
- Author:
- Jakub.Podlesak@Sun.COM, Paul.Sandoz@Sun.COM
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. |
JSONWithPadding |
readFrom(Class<JSONWithPadding> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream entityStream)
Read a type from the InputStream . |
void |
writeTo(JSONWithPadding t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP response. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
JSONWithPaddingProvider
public JSONWithPaddingProvider()
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.
- 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.
readFrom
public JSONWithPadding readFrom(Class<JSONWithPadding> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,String> httpHeaders,
InputStream entityStream)
throws IOException,
WebApplicationException
- 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:
IOException
- if an IO error arises
WebApplicationException
- if a specific
HTTP error response needs to be produced. Only effective if thrown prior
to the response being committed.
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.
- 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.
writeTo
public void writeTo(JSONWithPadding t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
throws IOException,
WebApplicationException
- 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:
IOException
- if an IO error arises
WebApplicationException
- if a specific
HTTP error response needs to be produced. Only effective if thrown prior
to the response being committed.
Copyright © 2013 Oracle Corporation. All Rights Reserved.