T
- 入力ストリームの要素の型 public interface Encoder<T>
<T>
のオブジェクトのストリームをバイトの出力ストリームにエンコードする方法。修飾子と型 | メソッドと説明 |
---|---|
boolean | canEncode(ResolvableType elementType, MimeType mimeType) エンコーダが特定のソース要素型と出力ストリームの MIME 型をサポートするかどうか。 |
reactor.core.publisher.Flux<DataBuffer> | encode(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints) 型 T のオブジェクトのストリームを DataBuffer 出力ストリームにエンコードします。 |
default DataBuffer | encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, MimeType mimeType, MapSE<StringSE, ObjectSE> hints) 型 T のオブジェクトをデータバッファにエンコードします。 |
ListSE<MimeType> | getEncodableMimeTypes() このエンコーダーでサポートされている MIME 型のリストを返します。 |
default ListSE<MimeType> | getEncodableMimeTypes(ResolvableType elementType) 指定された型の要素について、このエンコーダーでサポートされている MIME 型のリストを返します。 |
boolean canEncode(ResolvableType elementType, @Nullable MimeType mimeType)
elementType
- ソースストリーム内の要素の型 mimeType
- 出力ストリームの MIME 型 (指定しない場合は null
にすることができます)true
、サポートされていない場合は false
reactor.core.publisher.Flux<DataBuffer> encode(Publisher<? extends T> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE,ObjectSE> hints)
T
のオブジェクトのストリームを DataBuffer
出力ストリームにエンコードします。inputStream
- エンコードするオブジェクトの入力ストリーム。入力を要素のストリームとしてではなく単一の値としてエンコードする必要がある場合は、Mono
のインスタンスを使用する必要があります。bufferFactory
- 出力ストリーム DataBuffer
を作成するための elementType
- 入力ストリーム内の要素の予想される型。この型は、事前に canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType)
メソッドに渡されていなければならず、true
を返さなければなりません。mimeType
- 出力コンテンツの MIME 型 (オプション)hints
- エンコード方法に関する追加情報 default DataBuffer encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE,ObjectSE> hints)
デフォルトでは、このメソッドは UnsupportedOperationException
SE を発生させ、一部のエンコーダーは単一のバッファーを作成できないか、同期的に作成できないことが予想されます(例: Resource
のエンコード)。
value
- エンコードされる値 bufferFactory
- 出力 DataBuffer
を作成するため valueType
- エンコードされる値の型 mimeType
- 出力コンテンツの MIME 型 (オプション)hints
- エンコード方法に関する追加情報 ListSE<MimeType> getEncodableMimeTypes()
canEncode(elementType, null)
を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされている MIME 型を除外することもできます。または、getEncodableMimeTypes(ResolvableType)
を使用してより正確なリストを作成します。default ListSE<MimeType> getEncodableMimeTypes(ResolvableType elementType)
getEncodableMimeTypes()
とは異なる場合があります。elementType
- エンコーディングをチェックする要素の型