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