org.springframework.core.codec

Interface Encoder<T>

Type Parameters:

T - the type of elements in the input stream

All Known Implementing Classes:

AbstractEncoder, AbstractSingleValueEncoder, ByteArrayEncoder, ByteBufferEncoder, CharSequenceEncoder, DataBufferEncoder, 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 DataBuffer	encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, Map<String,Object> hints) Encode an Object of type T to a data buffer.
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 content (optional)

hints - additional information about how to encode

Returns:

the output stream

encodeValue

default DataBuffer encodeValue(T value,
                               DataBufferFactory bufferFactory,
                               ResolvableType valueType,
                               @Nullable
                               MimeType mimeType,
                               @Nullable
                               Map<String,Object> hints)

Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.

By default this method raises UnsupportedOperationException and it is expected that some encoders cannot produce a single buffer or cannot do so synchronously (e.g. encoding a Resource).

Parameters:

value - the value to be encoded

bufferFactory - for creating the output DataBuffer

valueType - the type for the value being encoded

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

hints - additional information about how to encode

Returns:

the encoded content

Since:

5.2

getEncodableMimeTypes

List<MimeType> getEncodableMimeTypes()

Return the list of mime types this encoder supports.