org.springframework.http.codec.json

Class KotlinSerializationJsonDecoder

java.lang.Object

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

org.springframework.http.codec.json.KotlinSerializationJsonDecoder

All Implemented Interfaces:

org.springframework.core.codec.Decoder<Object>

public class KotlinSerializationJsonDecoder
extends org.springframework.core.codec.AbstractDecoder<Object>

Decode a byte stream into JSON and convert to Object's with kotlinx.serialization.

This decoder can be used to bind @Serializable Kotlin classes, open polymorphic serialization is not supported. It supports application/json and application/*+json with various character sets, UTF-8 being the default.

Decoding streams is not supported yet, see kotlinx.serialization/issues/1073 related issue.

Since:

5.3

Author:

Sebastien Deleuze

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
KotlinSerializationJsonDecoder()
KotlinSerializationJsonDecoder(kotlinx.serialization.json.Json json)

Method Summary

Modifier and Type	Method and Description
boolean	canDecode(org.springframework.core.ResolvableType elementType, org.springframework.util.MimeType mimeType)
reactor.core.publisher.Flux<Object>	decode(Publisher<org.springframework.core.io.buffer.DataBuffer> inputStream, org.springframework.core.ResolvableType elementType, org.springframework.util.MimeType mimeType, Map<String,Object> hints)
reactor.core.publisher.Mono<Object>	decodeToMono(Publisher<org.springframework.core.io.buffer.DataBuffer> inputStream, org.springframework.core.ResolvableType elementType, org.springframework.util.MimeType mimeType, Map<String,Object> hints)
int	getMaxInMemorySize() Return the configured byte count limit.
void	setMaxInMemorySize(int byteCount) Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated.

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

getDecodableMimeTypes, getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.codec.Decoder

decode, getDecodableMimeTypes

Constructor Detail

KotlinSerializationJsonDecoder

public KotlinSerializationJsonDecoder()

KotlinSerializationJsonDecoder

public KotlinSerializationJsonDecoder(kotlinx.serialization.json.Json json)

Method Detail

setMaxInMemorySize

public void setMaxInMemorySize(int byteCount)

Configure a limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. This can be a result of decoding to a single DataBuffer, ByteBuffer, byte[], Resource, String, etc. It can also occur when splitting the input stream, e.g. delimited text, in which case the limit applies to data buffered between delimiters.

By default this is set to 256K.

Parameters:

byteCount - the max number of bytes to buffer, or -1 for unlimited

getMaxInMemorySize

public int getMaxInMemorySize()

Return the configured byte count limit.

canDecode

public boolean canDecode(org.springframework.core.ResolvableType elementType,
                         @Nullable
                         org.springframework.util.MimeType mimeType)

Specified by:

canDecode in interface org.springframework.core.codec.Decoder<Object>

Overrides:

canDecode in class org.springframework.core.codec.AbstractDecoder<Object>

decode

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

decodeToMono

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

Specified by:

decodeToMono in interface org.springframework.core.codec.Decoder<Object>

Overrides:

decodeToMono in class org.springframework.core.codec.AbstractDecoder<Object>