|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HttpMessageConverter<T>
Strategy interface that specifies a converter that can convert from and to HTTP requests and responses.
Method Summary | |
---|---|
boolean |
canRead(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be read by this converter. |
boolean |
canWrite(Class<?> clazz,
MediaType mediaType)
Indicates whether the given class can be written by this converter. |
List<MediaType> |
getSupportedMediaTypes()
Return the list of MediaType objects supported by this converter. |
T |
read(Class<? extends T> clazz,
HttpInputMessage inputMessage)
Read an object of the given type form the given input message, and returns it. |
void |
write(T t,
MediaType contentType,
HttpOutputMessage outputMessage)
Write an given object to the given output message. |
Method Detail |
---|
boolean canRead(Class<?> clazz, MediaType mediaType)
clazz
- the class to test for readabilitymediaType
- the media type to read, can be null
if not specified. Typically the value of a
Content-Type
header.
true
if readable; false
otherwiseboolean canWrite(Class<?> clazz, MediaType mediaType)
clazz
- the class to test for writabilitymediaType
- the media type to write, can be null
if not specified. Typically the value of an
Accept
header.
true
if writable; false
otherwiseList<MediaType> getSupportedMediaTypes()
MediaType
objects supported by this converter.
T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException
clazz
- the type of object to return. This type must have previously been passed to the
canRead
method of this interface, which must have returned true
.inputMessage
- the HTTP input message to read from
IOException
- in case of I/O errors
HttpMessageNotReadableException
- in case of conversion errorsvoid write(T t, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException
t
- the object to write to the output message. The type of this object must have previously been
passed to the canWrite
method of this interface, which must have returned true
.contentType
- the content type to use when writing. May be null
to indicate that the
default content type of the converter must be used. If not null
, this media type must have
previously been passed to the canWrite
method of this interface, which must have
returned true
.outputMessage
- the message to write to
IOException
- in case of I/O errors
HttpMessageNotWritableException
- in case of conversion errors
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |