パッケージ org.springframework.http.codec

インターフェース 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

  • メソッドの詳細

    • getWritableMediaTypes

      ListSE<MediaType> getWritableMediaTypes()
      このライターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null) を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、getWritableMediaTypes(ResolvableType) を使用してより正確なリストを作成します。
      戻り値:
      サポートされているメディア型の一般的なリスト

    • getWritableMediaTypes

      default ListSE<MediaType> getWritableMediaTypes(ResolvableType elementType)
      指定された型の要素について、このライターでサポートされているメディア型のリストを返します。Writer が要素型をサポートしていない場合、またはメディア型のサブセットに対してのみサポートしている場合、このリストは getWritableMediaTypes() とは異なる場合があります。
      パラメーター:
      elementType - エンコードする要素の型
      戻り値:
      特定のクラスでサポートされているメディア型のリスト
      導入:
      5.3.4

    • canWrite

      boolean canWrite(ResolvableType elementType, @Nullable MediaType mediaType)
      指定されたオブジェクト型がこのライターでサポートされているかどうか。
      パラメーター:
      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