public final class StringDecoder extends AbstractDataBufferDecoder<String>
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
.
CharSequenceEncoder
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.
|
logger
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" . |
decodeToMono
getDecodableMimeTypes, getLogger, setLogger
public static final Charset DEFAULT_CHARSET
public boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType)
Decoder
canDecode
in interface Decoder<String>
canDecode
in class AbstractDecoder<String>
elementType
- the target element type for the output streammimeType
- the mime type associated with the stream to decode
(can be null
if not specified)true
if supported, false
otherwisepublic reactor.core.publisher.Flux<String> decode(org.reactivestreams.Publisher<DataBuffer> input, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
Decoder
DataBuffer
input stream into a Flux of T
.decode
in interface Decoder<String>
decode
in class AbstractDataBufferDecoder<String>
input
- the DataBuffer
input stream to decodeelementType
- 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 encodeprotected String decodeDataBuffer(DataBuffer dataBuffer, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
AbstractDataBufferDecoder
DataBuffer
to the target element type.decodeDataBuffer
in class AbstractDataBufferDecoder<String>
@Deprecated public static StringDecoder textPlainOnly(boolean ignored)
textPlainOnly()
or
textPlainOnly(List, boolean)
StringDecoder
for "text/plain"
.ignored
- ignoredpublic static StringDecoder textPlainOnly()
StringDecoder
for "text/plain"
.public static StringDecoder textPlainOnly(List<String> delimiters, boolean stripDelimiter)
StringDecoder
for "text/plain"
.delimiters
- delimiter strings to use to split the input streamstripDelimiter
- whether to remove delimiters from the resulting
input strings@Deprecated public static StringDecoder allMimeTypes(boolean ignored)
allMimeTypes()
or
allMimeTypes(List, boolean)
StringDecoder
that supports all MIME types.ignored
- ignoredpublic static StringDecoder allMimeTypes()
StringDecoder
that supports all MIME types.public static StringDecoder allMimeTypes(List<String> delimiters, boolean stripDelimiter)
StringDecoder
that supports all MIME types.delimiters
- delimiter strings to use to split the input streamstripDelimiter
- whether to remove delimiters from the resulting
input strings