org.springframework.http.codec

Interface HttpMessageWriter<T>

All Known Subinterfaces:

ServerHttpMessageWriter<T>

All Known Implementing Classes:

AbstractServerHttpMessageWriter, EncoderHttpMessageWriter, FormHttpMessageWriter, Jackson2ServerHttpMessageWriter, ResourceHttpMessageWriter, ResourceRegionHttpMessageWriter, ServerSentEventHttpMessageWriter

public interface HttpMessageWriter<T>

Strategy interface that specifies a converter that can convert a stream of Objects to a stream of bytes to be written to the HTTP response body.

Since:

5.0

Author:

Rossen Stoyanchev, Arjen Poutsma, Sebastien Deleuze

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be written by this converter.
java.util.List<MediaType>	getWritableMediaTypes() Return the list of MediaType objects that can be written by this converter.
<any>	write(<any> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, java.util.Map<java.lang.String,java.lang.Object> hints) Write an given object to the given output message.

Method Detail

canWrite

boolean canWrite(ResolvableType elementType,
                 MediaType mediaType)

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

Parameters:

elementType - the stream element type 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

write

<any> write(<any> inputStream,
            ResolvableType elementType,
            MediaType mediaType,
            ReactiveHttpOutputMessage outputMessage,
            java.util.Map<java.lang.String,java.lang.Object> hints)

Write an given object to the given output message.

Parameters:

inputStream - the input stream to write

elementType - the stream element type to process. This type must have previously been passed to the canWrite(org.springframework.core.ResolvableType, org.springframework.http.MediaType) canWrite} method of this interface, which must have returned true.

mediaType - the content type to use when writing, typically the value of an Accept header. May be null to indicate that the default content type of the converter must be used.

outputMessage - the message to write to

hints - additional information about how to write

Returns:

a Mono that indicates completion or error

getWritableMediaTypes

java.util.List<MediaType> getWritableMediaTypes()

Return the list of MediaType objects that can be written by this converter.

Returns:

the list of supported readable media types