インターフェース HttpMessageWriter<T>
- 型パラメーター:
T
- 入力ストリーム内のオブジェクトの型
- すべての既知の実装クラス:
EncoderHttpMessageWriter
、FormHttpMessageWriter
、MultipartHttpMessageWriter
、PartEventHttpMessageWriter
、PartHttpMessageWriter
、ProtobufHttpMessageWriter
、ResourceHttpMessageWriter
、ServerSentEventHttpMessageWriter
public interface HttpMessageWriter<T>
型
<T>
のオブジェクトのストリームをエンコードし、エンコードされたバイトのストリームを ReactiveHttpOutputMessage
に書き込む方法。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Arjen Poutsma, Sebastien Deleuze
メソッドのサマリー
修飾子と型メソッド説明boolean
canWrite
(ResolvableType elementType, MediaType mediaType) 指定されたオブジェクト型がこのライターでサポートされているかどうか。このライターでサポートされているメディア型のリストを返します。getWritableMediaTypes
(ResolvableType elementType) 指定された型の要素について、このライターでサポートされているメディア型のリストを返します。default reactor.core.publisher.Mono<VoidSE>
write
(Publisher<? extends T> inputStream, ResolvableType actualType, ResolvableType elementType, MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストが利用可能な、write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
のサーバー側のみの代替。reactor.core.publisher.Mono<VoidSE>
write
(Publisher<? extends T> inputStream, ResolvableType elementType, MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) オブジェクトの特定のストリームを出力メッセージに書き込みます。
メソッドの詳細
getWritableMediaTypes
このライターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null)
を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、getWritableMediaTypes(ResolvableType)
を使用してより正確なリストを作成します。- 戻り値:
- サポートされているメディア型の一般的なリスト
getWritableMediaTypes
指定された型の要素について、このライターでサポートされているメディア型のリストを返します。Writer が要素型をサポートしていない場合、またはメディア型のサブセットに対してのみサポートしている場合、このリストはgetWritableMediaTypes()
とは異なる場合があります。- パラメーター:
elementType
- エンコードする要素の型- 戻り値:
- 特定のクラスでサポートされているメディア型のリスト
- 導入:
- 5.3.4
canWrite
指定されたオブジェクト型がこのライターでサポートされているかどうか。- パラメーター:
elementType
- チェックするオブジェクトの型mediaType
- 書き込みのメディア型 (おそらくnull
)- 戻り値:
- 書き込み可能な場合は
true
、それ以外の場合はfalse
write
reactor.core.publisher.Mono<VoidSE> write(Publisher<? extends T> inputStream, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) オブジェクトの特定のストリームを出力メッセージに書き込みます。- パラメーター:
inputStream
- 書き込むオブジェクトelementType
-canWrite(ResolvableType, MediaType)
を介して事前にチェックされている必要があるストリーム内のオブジェクトの型mediaType
- 書き込みのコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull
)message
- 書き込むメッセージhints
- エンコードおよび書き込み方法に関する追加情報- 戻り値:
- 完了またはエラーを示します
write
default reactor.core.publisher.Mono<VoidSE> write(Publisher<? extends T> inputStream, ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストが利用可能な、write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)
のサーバー側のみの代替。- パラメーター:
actualType
- 値を返したメソッドの実際の戻り値の型。アノテーション付きコントローラーの場合、MethodParameter
はResolvableType.getSource()
を介してアクセスできます。elementType
- 入力ストリーム内のオブジェクトの型mediaType
- 使用するコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull
)request
- 現在のリクエストresponse
- 現在のレスポンス- 戻り値:
- 書き込みの完了またはエラーを示す
Mono