Class ByteBufferDecoder

java.lang.Object

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

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

org.springframework.core.codec.ByteBufferDecoder

All Implemented Interfaces:

Decoder<ByteBuffer>

public class ByteBufferDecoder
extends AbstractDataBufferDecoder<ByteBuffer>

Decoder for ByteBuffers.

Since:

5.0

Author:

Sebastien Deleuze, Arjen Poutsma, Rossen Stoyanchev

Field Summary

Fields inherited from class AbstractDecoder

logger

Constructor Summary

Constructors

Constructor	Description
ByteBufferDecoder()

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(ResolvableType elementType, @Nullable MimeType mimeType)	Whether the decoder supports the given target element type and the MIME type of the source stream.
ByteBuffer	decode(DataBuffer dataBuffer, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)	Decode a data buffer to an Object of type T.

Methods inherited from class AbstractDataBufferDecoder

decode, decodeDataBuffer, decodeToMono, getMaxInMemorySize, setMaxInMemorySize

Methods inherited from class AbstractDecoder

getDecodableMimeTypes, getLogger, setLogger

Methods inherited from class Object

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

Methods inherited from interface Decoder

getDecodableMimeTypes

Constructor Details

ByteBufferDecoder

public ByteBufferDecoder()

Method Details

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 interface Decoder<ByteBuffer>

Overrides:

canDecode in class AbstractDecoder<ByteBuffer>

Parameters:

elementType - the target element type for the output stream

mimeType - the mime type associated with the stream to decode (can be null if not specified)

Returns:

true if supported, false otherwise

decode

public ByteBuffer decode(DataBuffer dataBuffer,
 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:

dataBuffer - the DataBuffer to decode

elementType - the expected output type

mimeType - the MIME type associated with the data

hints - additional information about how to do decode

Returns:

the decoded value, possibly null