org.springframework.core.codec

Class CharSequenceEncoder

  • All Implemented Interfaces:
    Encoder<java.lang.CharSequence>


    public final class CharSequenceEncoder
    extends AbstractEncoder<java.lang.CharSequence>
    Encode from a CharSequence stream to a bytes stream.
    Since:
    5.0
    Author:
    Sebastien Deleuze, Arjen Poutsma, Rossen Stoyanchev
    See Also:
    StringDecoder
    • Field Detail

      • DEFAULT_CHARSET

        public static final java.nio.charset.Charset DEFAULT_CHARSET
        The default charset used by the encoder.
    • Method Detail

      • canEncode

        public boolean canEncode(ResolvableType elementType,
                                 @Nullable
                                 MimeType mimeType)
        Description copied from interface: Encoder
        Whether the encoder supports the given source element type and the MIME type for the output stream.
        Specified by:
        canEncode in interface Encoder<java.lang.CharSequence>
        Overrides:
        canEncode in class AbstractEncoder<java.lang.CharSequence>
        Parameters:
        elementType - the type of elements in the source stream
        mimeType - the MIME type for the output stream (can be null if not specified)
        Returns:
        true if supported, false otherwise
      • encode

        public reactor.core.publisher.Flux<DataBuffer> encode(org.reactivestreams.Publisher<? extends java.lang.CharSequence> inputStream,
                                                              DataBufferFactory bufferFactory,
                                                              ResolvableType elementType,
                                                              @Nullable
                                                              MimeType mimeType,
                                                              @Nullable
                                                              java.util.Map<java.lang.String,java.lang.Object> hints)
        Description copied from interface: Encoder
        Encode a stream of Objects of type T into a DataBuffer output stream.
        Parameters:
        inputStream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.
        bufferFactory - for creating output stream DataBuffer's
        elementType - the expected type of elements in the input stream; this type must have been previously passed to the Encoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.
        mimeType - the MIME type for the output stream (optional)
        hints - additional information about how to do encode
        Returns:
        the output stream
      • textPlainOnly

        public static CharSequenceEncoder textPlainOnly()
        Create a CharSequenceEncoder that supports only "text/plain".
      • allMimeTypes

        public static CharSequenceEncoder allMimeTypes()
        Create a CharSequenceEncoder that supports all MIME types.