クラス KotlinSerializationStringEncoder<T extends kotlinx.serialization.StringFormat>
java.lang.ObjectSE
org.springframework.http.codec.KotlinSerializationSupport<T>
org.springframework.http.codec.KotlinSerializationStringEncoder<T>
- 型パラメーター:
T
-StringFormat
の型
- 既知の直属サブクラス
KotlinSerializationJsonEncoder
public abstract class KotlinSerializationStringEncoder<T extends kotlinx.serialization.StringFormat>
extends KotlinSerializationSupport<T>
implements Encoder<ObjectSE>
Kotlin 文字列シリアライザーに従う
Encoder
実装の抽象基本クラス。- 導入:
- 6.0
- 作成者:
- Sebastien Deleuze, Iain Henderson, Arjen Poutsma
フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクター修飾子コンストラクター説明protected
KotlinSerializationStringEncoder
(T format, MimeType... supportedMimeTypes) 方法の概要
修飾子と型メソッド説明boolean
canEncode
(ResolvableType elementType, MimeType mimeType) エンコーダが特定のソース要素型と出力ストリームの MIME 型をサポートするかどうか。reactor.core.publisher.Flux<DataBuffer>
encode
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints) 型T
のオブジェクトのストリームをDataBuffer
出力ストリームにエンコードします。protected reactor.core.publisher.Flux<DataBuffer>
encodeNonStream
(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints) protected DataBuffer
encodeStreamingValue
(ObjectSE value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints, byte[] prefix, byte[] suffix) encodeValue
(ObjectSE value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints) 型 T のオブジェクトをデータバッファにエンコードします。このエンコーダーでサポートされている MIME 型のリストを返します。getEncodableMimeTypes
(ResolvableType elementType) 指定された型の要素について、このエンコーダーでサポートされている MIME 型のリストを返します。void
setStreamingMediaTypes
(CollectionSE<MediaType> streamingMediaTypes) ストリーミングMediaTypes
を設定します。クラス org.springframework.http.codec.KotlinSerializationSupport から継承されたメソッド
canSerialize, format, serializer, supportedMimeTypes
フィールドの詳細
EMPTY_BYTES
protected static final byte[] EMPTY_BYTES
コンストラクターの詳細
KotlinSerializationStringEncoder
メソッドの詳細
setStreamingMediaTypes
ストリーミングMediaTypes
を設定します。- パラメーター:
streamingMediaTypes
- ストリーミングMediaTypes
- 導入:
- 6.1.4
canEncode
インターフェースからコピーされた説明:Encoder
エンコーダが特定のソース要素型と出力ストリームの MIME 型をサポートするかどうか。getEncodableMimeTypes
インターフェースからコピーされた説明:Encoder
このエンコーダーでサポートされている MIME 型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canEncode(elementType, null)
を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされている MIME 型を除外することもできます。または、Encoder.getEncodableMimeTypes(ResolvableType)
を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
Encoder<T extends kotlinx.serialization.StringFormat>
のgetEncodableMimeTypes
- 戻り値:
- サポートされている MIME 型のリスト
getEncodableMimeTypes
インターフェースからコピーされた説明:Encoder
指定された型の要素について、このエンコーダーでサポートされている MIME 型のリストを返します。このリストは、エンコーダーが要素型をサポートしていない場合、または MIME 型のサブセットに対してのみサポートしている場合、Encoder.getEncodableMimeTypes()
とは異なる場合があります。- 次で指定:
- インターフェース
Encoder<T extends kotlinx.serialization.StringFormat>
のgetEncodableMimeTypes
- パラメーター:
elementType
- エンコーディングをチェックする要素の型- 戻り値:
- 特定の要素型でサポートされている MIME 型のリスト
encode
public reactor.core.publisher.Flux<DataBuffer> encode(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:Encoder
型T
のオブジェクトのストリームをDataBuffer
出力ストリームにエンコードします。- 次で指定:
- インターフェース
Encoder<T extends kotlinx.serialization.StringFormat>
のencode
- パラメーター:
inputStream
- エンコードするオブジェクトの入力ストリーム。入力を要素のストリームとしてではなく単一の値としてエンコードする必要がある場合は、Mono
のインスタンスを使用する必要があります。bufferFactory
- 出力ストリームDataBuffer
を作成するためのelementType
- 入力ストリーム内の要素の予想される型。この型は、事前にEncoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
メソッドに渡されていなければならず、true
を返さなければなりません。mimeType
- 出力コンテンツの MIME 型 (オプション)hints
- エンコード方法に関する追加情報- 戻り値:
- 出力ストリーム
encodeStreamingValue
protected DataBuffer encodeStreamingValue(ObjectSE value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE, ObjectSE> hints, byte[] prefix, byte[] suffix) encodeNonStream
protected reactor.core.publisher.Flux<DataBuffer> encodeNonStream(Publisher<?> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE, ObjectSE> hints) encodeValue
public DataBuffer encodeValue(ObjectSE value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:Encoder
型 T のオブジェクトをデータバッファーにエンコードします。これは、個別のメッセージ(またはイベント)が完全に集約された形式で個別にエンコードおよび処理されるシナリオで役立ちます。デフォルトでは、このメソッドは
UnsupportedOperationException
SE を発生させ、一部のエンコーダーは単一のバッファーを生成できないか、同期的に生成できないことが予想されます (たとえば、Resource
をエンコードする)。- 次で指定:
- インターフェース
Encoder<T extends kotlinx.serialization.StringFormat>
のencodeValue
- パラメーター:
value
- エンコードされる値bufferFactory
- 出力DataBuffer
を作成するためvalueType
- エンコードされる値の型mimeType
- 出力コンテンツの MIME 型 (オプション)hints
- エンコード方法に関する追加情報- 戻り値:
- エンコードされたコンテンツ