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

インターフェース Encoder<T>

型パラメーター:
T - 入力ストリームの要素の型
すべての既知のサブインターフェース:
HttpMessageEncoder<T>
すべての既知の実装クラス:
AbstractEncoder、AbstractJackson2Encoder、AbstractSingleValueEncoder、ByteArrayEncoder、ByteBufferEncoder、CharSequenceEncoder、DataBufferEncoder、Jackson2CborEncoder、Jackson2JsonEncoder、Jackson2SmileEncoder、Jaxb2XmlEncoder、KotlinSerializationBinaryEncoder、KotlinSerializationCborEncoder、KotlinSerializationJsonEncoder、KotlinSerializationProtobufEncoder、KotlinSerializationStringEncoder、Netty5BufferEncoder、NettyByteBufEncoder、ProtobufEncoder、ResourceEncoder、ResourceRegionEncoder
public interface Encoder<T>
型 <T> のオブジェクトのストリームをバイトの出力ストリームにエンコードする方法。
導入:
5.0
作成者:
Sebastien Deleuze, Rossen Stoyanchev

  • メソッドの詳細

    • canEncode

      boolean canEncode(ResolvableType elementType, @Nullable MimeType mimeType)
      エンコーダが特定のソース要素型と出力ストリームの MIME 型をサポートするかどうか。
      パラメーター:
      elementType - ソースストリーム内の要素の型
      mimeType - 出力ストリームの MIME 型 (指定しない場合は null にすることができます)
      戻り値:
      サポートされている場合は true、サポートされていない場合は false 

    • encode

      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 - エンコード方法に関する追加情報
      戻り値:
      出力ストリーム

    • encodeValue

      default DataBuffer encodeValue(T value, DataBufferFactory bufferFactory, ResolvableType valueType, @Nullable MimeType mimeType, @Nullable MapSE<StringSE,ObjectSE> hints)
      型 T のオブジェクトをデータバッファーにエンコードします。これは、個別のメッセージ（またはイベント）が完全に集約された形式で個別にエンコードおよび処理されるシナリオで役立ちます。

      デフォルトでは、このメソッドは UnsupportedOperationExceptionSE を発生させ、一部のエンコーダーは単一のバッファーを作成できないか、同期的に作成できないことが予想されます（例: Resource のエンコード）。

      パラメーター:
      value - エンコードされる値
      bufferFactory - 出力 DataBuffer を作成するため
      valueType - エンコードされる値の型
      mimeType - 出力コンテンツの MIME 型 (オプション)
      hints - エンコード方法に関する追加情報
      戻り値:
      エンコードされたコンテンツ
      導入:
      5.2

    • getEncodableMimeTypes

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

    • getEncodableMimeTypes

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