org.springframework.http.codec

Class EncoderHttpMessageWriter<T>

java.lang.Object

org.springframework.http.codec.EncoderHttpMessageWriter<T>

All Implemented Interfaces:

HttpMessageWriter<T>

public class EncoderHttpMessageWriter<T>
extends Object
implements HttpMessageWriter<T>

Implementation of the HttpMessageWriter interface that delegates to an Encoder.

Since:

5.0

Author:

Arjen Poutsma, Sebastien Deleuze, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
EncoderHttpMessageWriter(org.springframework.core.codec.Encoder<T> encoder) Create a CodecHttpMessageConverter with the given Encoder.

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(org.springframework.core.ResolvableType elementType, MediaType mediaType) Indicates whether the given class can be written by this converter.
protected MediaType	getDefaultContentType(org.springframework.core.ResolvableType elementType) Return the default content type for the given ResolvableType.
List<MediaType>	getWritableMediaTypes() Return the list of MediaType objects that can be written by this converter.
reactor.core.publisher.Mono<Void>	write(org.reactivestreams.Publisher<? extends T> inputStream, org.springframework.core.ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage outputMessage, Map<String,Object> hints) Write an given object to the given output message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncoderHttpMessageWriter

public EncoderHttpMessageWriter(org.springframework.core.codec.Encoder<T> encoder)

Create a CodecHttpMessageConverter with the given Encoder.

Parameters:

encoder - the encoder to use

Method Detail

canWrite

public boolean canWrite(org.springframework.core.ResolvableType elementType,
                        MediaType mediaType)

Description copied from interface: HttpMessageWriter

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

Specified by:

canWrite in interface HttpMessageWriter<T>

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

getWritableMediaTypes

public List<MediaType> getWritableMediaTypes()

Description copied from interface: HttpMessageWriter

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

Specified by:

getWritableMediaTypes in interface HttpMessageWriter<T>

Returns:

the list of supported readable media types

write

public reactor.core.publisher.Mono<Void> write(org.reactivestreams.Publisher<? extends T> inputStream,
                                               org.springframework.core.ResolvableType elementType,
                                               MediaType mediaType,
                                               ReactiveHttpOutputMessage outputMessage,
                                               Map<String,Object> hints)

Description copied from interface: HttpMessageWriter

Write an given object to the given output message.

Specified by:

write in interface HttpMessageWriter<T>

Parameters:

inputStream - the input stream to write

elementType - the stream element type to process. This type must have previously been passed to the HttpMessageWriter.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

getDefaultContentType

protected MediaType getDefaultContentType(org.springframework.core.ResolvableType elementType)

Return the default content type for the given ResolvableType. Used when write(org.reactivestreams.Publisher<? extends T>, org.springframework.core.ResolvableType, org.springframework.http.MediaType, org.springframework.http.ReactiveHttpOutputMessage, java.util.Map<java.lang.String, java.lang.Object>) is called without a concrete content type.

By default returns the first of encodableMimeTypes that is concrete(MimeType.isConcrete()), if any.

Parameters:

elementType - the type of element for encoding

Returns:

the content type, or null