org.springframework.core.codec

Class StringDecoder

java.lang.Object

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

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

org.springframework.core.codec.StringDecoder

All Implemented Interfaces:

Decoder<String>

public final class StringDecoder
extends AbstractDataBufferDecoder<String>

Decode from a data buffer stream to a String stream. Before decoding, this decoder realigns the incoming data buffers so that each buffer ends with a newline. This is to make sure that multibyte characters are decoded properly, and do not cross buffer boundaries. The default delimiters (\n, \r\n)can be customized.

Partially inspired by Netty's DelimiterBasedFrameDecoder.

Since:

5.0

Author:

Sebastien Deleuze, Brian Clozel, Arjen Poutsma, Mark Paluch

See Also:

CharSequenceEncoder

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	DEFAULT_CHARSET The default charset to use, i.e.
static List<String>	DEFAULT_DELIMITERS The default delimiter strings to use, i.e.

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

logger

Method Summary

Modifier and Type	Method and Description
static StringDecoder	allMimeTypes() Create a StringDecoder that supports all MIME types.
static StringDecoder	allMimeTypes(boolean ignored) Deprecated. as of Spring 5.0.4, in favor of allMimeTypes() or allMimeTypes(List, boolean)
static StringDecoder	allMimeTypes(List<String> delimiters, boolean stripDelimiter) Create a StringDecoder that supports all MIME types.
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<String>	decode(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) Decode a DataBuffer input stream into a Flux of T.
protected String	decodeDataBuffer(DataBuffer dataBuffer, ResolvableType elementType, MimeType mimeType, Map<String,Object> hints) How to decode a DataBuffer to the target element type.
static StringDecoder	textPlainOnly() Create a StringDecoder for "text/plain".
static StringDecoder	textPlainOnly(boolean ignored) Deprecated. as of Spring 5.0.4, in favor of textPlainOnly() or textPlainOnly(List, boolean)
static StringDecoder	textPlainOnly(List<String> delimiters, boolean stripDelimiter) Create a StringDecoder for "text/plain".

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

decodeToMono, getMaxInMemorySize, setMaxInMemorySize

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

Field Detail

DEFAULT_CHARSET

public static final Charset DEFAULT_CHARSET

The default charset to use, i.e. "UTF-8".

DEFAULT_DELIMITERS

public static final List<String> DEFAULT_DELIMITERS

The default delimiter strings to use, i.e. \r\n and \n.

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

Overrides:

canDecode in class AbstractDecoder<String>

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 reactor.core.publisher.Flux<String> decode(org.reactivestreams.Publisher<DataBuffer> input,
                                                  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.

Specified by:

decode in interface Decoder<String>

Overrides:

decode in class AbstractDataBufferDecoder<String>

Parameters:

input - 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

decodeDataBuffer

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

Description copied from class: AbstractDataBufferDecoder

How to decode a DataBuffer to the target element type.

Specified by:

decodeDataBuffer in class AbstractDataBufferDecoder<String>

textPlainOnly

@Deprecated
public static StringDecoder textPlainOnly(boolean ignored)

Deprecated. as of Spring 5.0.4, in favor of textPlainOnly() or textPlainOnly(List, boolean)

Create a StringDecoder for "text/plain".

Parameters:

ignored - ignored

textPlainOnly

public static StringDecoder textPlainOnly()

Create a StringDecoder for "text/plain".

textPlainOnly

public static StringDecoder textPlainOnly(List<String> delimiters,
                                          boolean stripDelimiter)

Create a StringDecoder for "text/plain".

Parameters:

delimiters - delimiter strings to use to split the input stream

stripDelimiter - whether to remove delimiters from the resulting input strings

allMimeTypes

@Deprecated
public static StringDecoder allMimeTypes(boolean ignored)

Deprecated. as of Spring 5.0.4, in favor of allMimeTypes() or allMimeTypes(List, boolean)

Create a StringDecoder that supports all MIME types.

Parameters:

ignored - ignored

allMimeTypes

public static StringDecoder allMimeTypes()

Create a StringDecoder that supports all MIME types.

allMimeTypes

public static StringDecoder allMimeTypes(List<String> delimiters,
                                         boolean stripDelimiter)

Create a StringDecoder that supports all MIME types.

Parameters:

delimiters - delimiter strings to use to split the input stream

stripDelimiter - whether to remove delimiters from the resulting input strings