|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageBodyWriter<T>
Contract for a provider that supports the conversion of a Java type to a
stream. To add a MessageBodyWriter
implementation, annotate the
implementation class with @Provider
.
A MessageBodyWriter
implementation may be annotated
with @ProduceMime
to restrict the media types for which it will
be considered suitable.
Provider
,
ProduceMime
Method Summary | |
---|---|
long |
getSize(T t)
Called before writeTo to ascertain the length in bytes of
the serialized form of t . |
boolean |
isWriteable(java.lang.Class<?> type)
Ascertain if the MessageBodyWriter supports a particular type. |
void |
writeTo(T t,
MediaType mediaType,
MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders,
java.io.OutputStream entityStream)
Write a type to an HTTP response. |
Method Detail |
---|
boolean isWriteable(java.lang.Class<?> type)
type
- the type that is to be supported.
long getSize(T t)
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 type
void writeTo(T t, MediaType mediaType, MultivaluedMap<java.lang.String,java.lang.Object> httpHeaders, java.io.OutputStream entityStream) throws java.io.IOException
t
- the type to write.mediaType
- the media type of the HTTP entity.httpHeaders
- a mutable map of the HTTP response headers.entityStream
- the OutputStream
for the HTTP entity.
java.io.IOException
- if an IO error arises
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |