Package org.springframework.http.codec

Class KotlinSerializationStringEncoder<T extends kotlinx.serialization.StringFormat>

java.lang.Object
org.springframework.http.codec.KotlinSerializationSupport<T>
org.springframework.http.codec.KotlinSerializationStringEncoder<T>
Type Parameters:
T - the type of StringFormat
All Implemented Interfaces:
Encoder<Object>
Direct Known Subclasses:
KotlinSerializationJsonEncoder
public abstract class KotlinSerializationStringEncoder<T extends kotlinx.serialization.StringFormat> extends KotlinSerializationSupport<T> implements Encoder<Object>
Abstract base class for Encoder implementations that defer to Kotlin string serializers.
Since:
6.0
Author:
Sebastien Deleuze, Iain Henderson, Arjen Poutsma

  • Field Details

    • EMPTY_BYTES

      protected static final byte[] EMPTY_BYTES

  • Constructor Details

    • KotlinSerializationStringEncoder

      protected KotlinSerializationStringEncoder(T format, MimeType... supportedMimeTypes)

  • Method Details

    • setStreamingMediaTypes

      public void setStreamingMediaTypes(Collection<MediaType> streamingMediaTypes)
      Set streaming MediaTypes.
      Parameters:
      streamingMediaTypes - streaming MediaTypes
      Since:
      6.1.4

    • 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<T extends kotlinx.serialization.StringFormat>
      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

    • getEncodableMimeTypes

      public List<MimeType> getEncodableMimeTypes()
      Description copied from interface: Encoder
      Return the list of MIME types supported by this Encoder. The list may not apply to every possible target element type and calls to this method should typically be guarded via canEncode(elementType, null). The list may also exclude MIME types supported only for a specific element type. Alternatively, use Encoder.getEncodableMimeTypes(ResolvableType) for a more precise list.
      Specified by:
      getEncodableMimeTypes in interface Encoder<T extends kotlinx.serialization.StringFormat>
      Returns:
      the list of supported MIME types

    • getEncodableMimeTypes

      public List<MimeType> getEncodableMimeTypes(ResolvableType elementType)
      Description copied from interface: Encoder
      Return the list of MIME types supported by this Encoder for the given type of element. This list may differ from the Encoder.getEncodableMimeTypes() if the Encoder doesn't support the element type or if it supports it only for a subset of MIME types.
      Specified by:
      getEncodableMimeTypes in interface Encoder<T extends kotlinx.serialization.StringFormat>
      Parameters:
      elementType - the type of element to check for encoding
      Returns:
      the list of MIME types supported for the given element type

    • encode

      public reactor.core.publisher.Flux<DataBuffer> encode(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
      Description copied from interface: Encoder
      Encode a stream of Objects of type T into a DataBuffer output stream.
      Specified by:
      encode in interface Encoder<T extends kotlinx.serialization.StringFormat>
      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 content (optional)
      hints - additional information about how to encode
      Returns:
      the output stream

    • encodeStreamingValue

      protected DataBuffer encodeStreamingValue(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints, byte[] prefix, byte[] suffix)

    • encodeNonStream

      protected reactor.core.publisher.Flux<DataBuffer> encodeNonStream(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)

    • encodeValue

      public DataBuffer encodeValue(Object value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable Map<String,Object> hints)
      Description copied from interface: Encoder
      Encode an Object of type T to a data buffer. This is useful for scenarios, that distinct messages (or events) are encoded and handled individually, in fully aggregated form.

      By default this method raises UnsupportedOperationException and it is expected that some encoders cannot produce a single buffer or cannot do so synchronously (for example, encoding a Resource).

      Specified by:
      encodeValue in interface Encoder<T extends kotlinx.serialization.StringFormat>
      Parameters:
      value - the value to be encoded
      bufferFactory - for creating the output DataBuffer
      valueType - the type for the value being encoded
      mimeType - the MIME type for the output content (optional)
      hints - additional information about how to encode
      Returns:
      the encoded content