Package org.springframework.core.codec
Class StringDecoder
java.lang.Object
org.springframework.core.codec.AbstractDecoder<T>
org.springframework.core.codec.AbstractDataBufferDecoder<T>
org.springframework.core.codec.AbstractCharSequenceDecoder<String>
org.springframework.core.codec.StringDecoder
Decode from a data buffer stream to a
String
stream, either splitting
or aggregating incoming data chunks to realign along newlines delimiters
and produce a stream of strings. This is useful for streaming but is also
necessary to ensure that multi-byte characters can be decoded correctly,
avoiding split-character issues. The default delimiters used by default are
\n
and \r\n
but that can be customized.- Since:
- 5.0
- Author:
- Sebastien Deleuze, Brian Clozel, Arjen Poutsma, Mark Paluch
- See Also:
-
Field Summary
Fields inherited from class org.springframework.core.codec.AbstractCharSequenceDecoder
DEFAULT_CHARSET, DEFAULT_DELIMITERS
Fields inherited from class org.springframework.core.codec.AbstractDecoder
logger
-
Method Summary
Modifier and TypeMethodDescriptionstatic StringDecoder
Create aStringDecoder
that supports all MIME types.static StringDecoder
allMimeTypes
(List<String> delimiters, boolean stripDelimiter) Create aStringDecoder
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.protected String
decodeInternal
(DataBuffer dataBuffer, Charset charset) Template method that decodes the given data buffer intoT
, given the charset.static StringDecoder
Create aStringDecoder
for"text/plain"
.static StringDecoder
textPlainOnly
(List<String> delimiters, boolean stripDelimiter) Create aStringDecoder
for"text/plain"
.Methods inherited from class org.springframework.core.codec.AbstractCharSequenceDecoder
decode, decode, getDefaultCharset, setDefaultCharset
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
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
getDecodableMimeTypes
-
Method Details
-
canDecode
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<String>
- Overrides:
canDecode
in classAbstractDecoder<String>
- 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
-
decodeInternal
Description copied from class:AbstractCharSequenceDecoder
Template method that decodes the given data buffer intoT
, given the charset.- Specified by:
decodeInternal
in classAbstractCharSequenceDecoder<String>
-
textPlainOnly
Create aStringDecoder
for"text/plain"
. -
textPlainOnly
Create aStringDecoder
for"text/plain"
.- Parameters:
delimiters
- delimiter strings to use to split the input streamstripDelimiter
- whether to remove delimiters from the resulting input strings
-
allMimeTypes
Create aStringDecoder
that supports all MIME types. -
allMimeTypes
Create aStringDecoder
that supports all MIME types.- Parameters:
delimiters
- delimiter strings to use to split the input streamstripDelimiter
- whether to remove delimiters from the resulting input strings
-