Summary: Methods | [Expand All]
public interface

HttpMessageConverter

org.springframework.http.converter.HttpMessageConverter<T>
Known Indirect Subclasses

Class Overview

Strategy interface that specifies a converter that can convert from and to HTTP requests and responses.

Summary

Public Methods
abstract boolean canRead(Class<?> clazz, MediaType mediaType)
Indicates whether the given class can be read by this converter.
abstract boolean canWrite(Class<?> clazz, MediaType mediaType)
Indicates whether the given class can be written by this converter.
abstract List<MediaType> getSupportedMediaTypes()
Return the list of MediaType objects supported by this converter.
abstract T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
Read an object of the given type form the given input message, and returns it.
abstract void write(T t, MediaType contentType, HttpOutputMessage outputMessage)
Write an given object to the given output message.

Public Methods

public abstract boolean canRead (Class<?> clazz, MediaType mediaType)

Indicates whether the given class can be read by this converter.

Parameters
clazz the class to test for readability
mediaType the media type to read, can be null if not specified. Typically the value of a Content-Type header.
Returns
  • true if readable; false otherwise

public abstract boolean canWrite (Class<?> clazz, MediaType mediaType)

Indicates whether the given class can be written by this converter.

Parameters
clazz the class to test for writability
mediaType the media type to write, can be null if not specified. Typically the value of an Accept header.
Returns
  • true if writable; false otherwise

public abstract List<MediaType> getSupportedMediaTypes ()

Return the list of MediaType objects supported by this converter.

Returns
  • the list of supported media types

public abstract T read (Class<? extends T> clazz, HttpInputMessage inputMessage)

Read an object of the given type form the given input message, and returns it.

Parameters
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
Returns
  • the converted object
Throws
IOException in case of I/O errors
HttpMessageNotReadableException in case of conversion errors

public abstract void write (T t, MediaType contentType, HttpOutputMessage outputMessage)

Write an given object to the given output message.

Parameters
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
Throws
IOException in case of I/O errors
HttpMessageNotWritableException in case of conversion errors