org.springframework.core.codec

Interface Encoder<T>

Type Parameters:

T - the type of elements in the input stream

All Known Subinterfaces:

HttpMessageEncoder<T>

All Known Implementing Classes:

AbstractEncoder, AbstractJackson2Encoder, AbstractSingleValueEncoder, ByteArrayEncoder, ByteBufferEncoder, CharSequenceEncoder, DataBufferEncoder, Jackson2JsonEncoder, Jackson2SmileEncoder, Jaxb2XmlEncoder, ResourceEncoder, ResourceRegionEncoder

public interface Encoder<T>

Strategy to encode a stream of Objects of type <T> into an output stream of bytes.

Since:

5.0

Author:

Sebastien Deleuze, Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
boolean	canEncode(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.
reactor.core.publisher.Flux<DataBuffer>	encode(org.reactivestreams.Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) Encode a stream of Objects of type T into a DataBuffer output stream.
default Long	getContentLength(T t, MimeType mimeType) Deprecated. this method was added so EncoderHttpMessageWriter can set the content-length header. However after further improvements as of 5.0.7, it is no longer needed, and not used.
List<MimeType>	getEncodableMimeTypes() Return the list of mime types this encoder supports.

Method Detail

canEncode

boolean canEncode(ResolvableType elementType,
                  @Nullable
                  MimeType mimeType)

Whether the encoder supports the given source element type and the MIME type for the output stream.

Parameters:

elementType - the type of elements in the source stream

mimeType - the MIME type for the output stream (can be null if not specified)

Returns:

true if supported, false otherwise

encode

reactor.core.publisher.Flux<DataBuffer> encode(org.reactivestreams.Publisher<? extends T> inputStream,
                                               DataBufferFactory bufferFactory,
                                               ResolvableType elementType,
                                               @Nullable
                                               MimeType mimeType,
                                               @Nullable
                                               Map<String,Object> hints)

Encode a stream of Objects of type T into a DataBuffer output stream.

Parameters:

inputStream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.

bufferFactory - for creating output stream DataBuffer's

elementType - the expected type of elements in the input stream; this type must have been previously passed to the canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.

mimeType - the MIME type for the output stream (optional)

hints - additional information about how to do encode

Returns:

the output stream

getContentLength

@Nullable
 @Deprecated
default Long getContentLength(T t,
                                                     @Nullable
                                                     MimeType mimeType)

Deprecated. this method was added so EncoderHttpMessageWriter can set the content-length header. However after further improvements as of 5.0.7, it is no longer needed, and not used.

Return the length for the given item, if known.

Parameters:

t - the item to check

Returns:

the length in bytes, or null if not known.

Since:

5.0.5

getEncodableMimeTypes

List<MimeType> getEncodableMimeTypes()

Return the list of mime types this encoder supports.