public interface MessageBodyWriter<T>
MessageBodyWriter
implementation, annotate the
implementation class with @Provider
.
A MessageBodyWriter
implementation may be annotated
with Produces
to restrict the media types for which it will
be considered suitable.Modifier and Type | Method and Description |
---|---|
long |
getSize(T t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Called before
writeTo to ascertain the length in bytes of
the serialized form of t . |
boolean |
isWriteable(Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType)
Ascertain if the MessageBodyWriter supports a particular type.
|
void |
writeTo(T t,
Class<?> type,
Type genericType,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> httpHeaders,
OutputStream entityStream)
Write a type to an HTTP response.
|
boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
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.long getSize(T t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
writeTo
to ascertain the length in bytes of
the serialized form of t
. A non-negative return value is
used in a HTTP Content-Length
header.t
- the instance to writetype
- 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.void writeTo(T t, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationException
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.IOException
- if an IO error arisesWebApplicationException
- if a specific
HTTP error response needs to be produced. Only effective if thrown prior
to the response being committed.Copyright © 2012 JBoss by Red Hat. All Rights Reserved.