org.springframework.core.codec

Class AbstractDataBufferDecoder<T>

java.lang.Object

org.springframework.core.codec.AbstractDecoder<T>

org.springframework.core.codec.AbstractDataBufferDecoder<T>

All Implemented Interfaces:

Decoder<T>

Direct Known Subclasses:

ByteArrayDecoder, ByteBufferDecoder, DataBufferDecoder, ResourceDecoder, StringDecoder

public abstract class AbstractDataBufferDecoder<T>
extends AbstractDecoder<T>

Abstract base class for Decoder implementations that can decode a DataBuffer directly to the target element type.

Sub-classes must implement decodeDataBuffer(org.springframework.core.io.buffer.DataBuffer, org.springframework.core.ResolvableType, org.springframework.util.MimeType, java.util.Map<java.lang.String, java.lang.Object>) to provide a way to transform a DataBuffer to the target data type. The default decode(org.reactivestreams.Publisher<org.springframework.core.io.buffer.DataBuffer>, org.springframework.core.ResolvableType, org.springframework.util.MimeType, java.util.Map<java.lang.String, java.lang.Object>) implementation transforms each individual data buffer while decodeToMono(org.reactivestreams.Publisher<org.springframework.core.io.buffer.DataBuffer>, org.springframework.core.ResolvableType, org.springframework.util.MimeType, java.util.Map<java.lang.String, java.lang.Object>) applies "reduce" and transforms the aggregated buffer.

Sub-classes can override decode(org.reactivestreams.Publisher<org.springframework.core.io.buffer.DataBuffer>, org.springframework.core.ResolvableType, org.springframework.util.MimeType, java.util.Map<java.lang.String, java.lang.Object>) in order to split the input stream along different boundaries (e.g. on new line characters for String) or always reduce to a single data buffer (e.g. Resource).

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDataBufferDecoder(MimeType... supportedMimeTypes)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Flux<T>	decode(org.reactivestreams.Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) Decode a DataBuffer input stream into a Flux of T.
protected abstract T	decodeDataBuffer(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) How to decode a DataBuffer to the target element type.
reactor.core.publisher.Mono<T>	decodeToMono(org.reactivestreams.Publisher<DataBuffer> inputStream, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) Decode a DataBuffer input stream into a Mono of T.

Methods inherited from class org.springframework.core.codec.AbstractDecoder

canDecode, getDecodableMimeTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataBufferDecoder

protected AbstractDataBufferDecoder(MimeType... supportedMimeTypes)

Method Detail

decode

public reactor.core.publisher.Flux<T> decode(org.reactivestreams.Publisher<DataBuffer> inputStream,
                                             ResolvableType elementType,
                                             @Nullable
                                             MimeType mimeType,
                                             @Nullable
                                             Map<String,Object> hints)

Description copied from interface: Decoder

Decode a DataBuffer input stream into a Flux of T.

Parameters:

inputStream - the DataBuffer input stream to decode

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

mimeType - the MIME type associated with the input stream (optional)

hints - additional information about how to do encode

Returns:

the output stream with decoded elements

decodeToMono

public reactor.core.publisher.Mono<T> decodeToMono(org.reactivestreams.Publisher<DataBuffer> inputStream,
                                                   ResolvableType elementType,
                                                   @Nullable
                                                   MimeType mimeType,
                                                   @Nullable
                                                   Map<String,Object> hints)

Description copied from interface: Decoder

Decode a DataBuffer input stream into a Mono of T.

Specified by:

decodeToMono in interface Decoder<T>

Overrides:

decodeToMono in class AbstractDecoder<T>

Parameters:

inputStream - the DataBuffer input stream to decode

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

mimeType - the MIME type associated with the input stream (optional)

hints - additional information about how to do encode

Returns:

the output stream with the decoded element

decodeDataBuffer

protected abstract T decodeDataBuffer(DataBuffer buffer,
                                      ResolvableType elementType,
                                      @Nullable
                                      MimeType mimeType,
                                      @Nullable
                                      Map<String,Object> hints)

How to decode a DataBuffer to the target element type.