Package org.springframework.core.codec
Class DataBufferDecoder
- java.lang.Object
- org.springframework.core.codec.AbstractDecoder<T>
- org.springframework.core.codec.AbstractDataBufferDecoder<DataBuffer>
- org.springframework.core.codec.DataBufferDecoder
- All Implemented Interfaces:
Decoder<DataBuffer>
public class DataBufferDecoder extends AbstractDataBufferDecoder<DataBuffer>
Simple pass-through decoder forDataBuffers
.Note: The data buffers should be released via
DataBufferUtils.release(DataBuffer)
after they have been consumed. In addition, if usingFlux
orMono
operators such as flatMap, reduce, and others that prefetch, cache, and skip or filter out data items internally, please adddoOnDiscard(PooledDataBuffer.class, DataBufferUtils::release)
to the composition chain to ensure cached data buffers are released prior to an error or cancellation signal.- Since:
- 5.0
- Author:
- Arjen Poutsma, Rossen Stoyanchev
Field Summary
Fields inherited from class org.springframework.core.codec.AbstractDecoder
logger
Constructor Summary
Constructors Constructor Description DataBufferDecoder()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canDecode(ResolvableType elementType, MimeType mimeType)
Whether the decoder supports the given target element type and the MIME type of the source stream.reactor.core.publisher.Flux<DataBuffer>
decode(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints)
Decode aDataBuffer
input stream into a Flux ofT
.DataBuffer
decode(DataBuffer buffer, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints)
Decode a data buffer to an Object of type T.Methods inherited from class org.springframework.core.codec.AbstractDataBufferDecoder
decodeDataBuffer, decodeToMono, getMaxInMemorySize, setMaxInMemorySize
Methods inherited from class org.springframework.core.codec.AbstractDecoder
getDecodableMimeTypes, getLogger, setLogger
Constructor Detail
DataBufferDecoder
public DataBufferDecoder()
Method Detail
canDecode
public boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType)
Description copied from interface:Decoder
Whether the decoder supports the given target element type and the MIME type of the source stream.- Specified by:
canDecode
in interfaceDecoder<DataBuffer>
- Overrides:
canDecode
in classAbstractDecoder<DataBuffer>
- Parameters:
elementType
- the target element type for the output streammimeType
- the mime type associated with the stream to decode (can benull
if not specified)- Returns:
true
if supported,false
otherwise
decode
public reactor.core.publisher.Flux<DataBuffer> decode(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
Description copied from interface:Decoder
Decode aDataBuffer
input stream into a Flux ofT
.- Specified by:
decode
in interfaceDecoder<DataBuffer>
- Overrides:
decode
in classAbstractDataBufferDecoder<DataBuffer>
- Parameters:
input
- theDataBuffer
input stream to decodeelementType
- the expected type of elements in the output stream; this type must have been previously passed to theDecoder.canDecode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
method and it must have returnedtrue
.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
decode
public DataBuffer decode(DataBuffer buffer, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
Description copied from interface:Decoder
Decode a data buffer to an Object of type T. This is useful for scenarios, that distinct messages (or events) are decoded and handled individually, in fully aggregated form.- Parameters:
buffer
- theDataBuffer
to decodeelementType
- the expected output typemimeType
- the MIME type associated with the datahints
- additional information about how to do encode- Returns:
- the decoded value, possibly
null