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

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

型パラメーター:
T - 変換されたオブジェクト型
すべてのスーパーインターフェース:
HttpMessageConverter<T>
すべての既知の実装クラス:
AbstractKotlinSerializationHttpMessageConverter、AbstractSmartHttpMessageConverter、KotlinSerializationBinaryHttpMessageConverter、KotlinSerializationCborHttpMessageConverter、KotlinSerializationJsonHttpMessageConverter、KotlinSerializationProtobufHttpMessageConverter、KotlinSerializationStringHttpMessageConverter
public interface SmartHttpMessageConverter<T> extends HttpMessageConverter<T>
HttpMessageConverter の特殊化であり、HTTP リクエストを指定された ResolvableType のターゲットオブジェクトに変換し、指定された ResolvableType のソースオブジェクトをオプションのヒントを含む HTTP レスポンスに変換できます。

サブクラスがスマート API のみを実装できるように、HttpMessageConverter のデフォルトメソッドを提供します。

導入:
6.2
作成者:
Sebastien Deleuze

  • メソッドの詳細

    • canRead

      boolean canRead(ResolvableType type, @Nullable MediaType mediaType)
      指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用して HttpMessageConverter.canRead(Class, MediaType) と同じチェックを実行する必要があります。
      パラメーター:
      type - 読みやすさをテストする (潜在的にジェネリクスな) 型。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。
      mediaType - 読み取るメディア型。指定されていない場合は null にすることができます。通常、Content-Type ヘッダーの値。
      戻り値:
      読み取り可能な場合は true。それ以外の場合は false 

    • canRead

      default boolean canRead(ClassSE<?> clazz, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: HttpMessageConverter
      指定されたクラスがこのコンバーターで読み取れるかどうかを示します。
      次で指定:
      インターフェース HttpMessageConverter<T> の canRead 
      パラメーター:
      clazz - 読み込み可能性をテストするクラス
      mediaType - 読み取るメディア型（指定しない場合は null にできます）; 通常、Content-Type ヘッダーの値。
      戻り値:
      読み取り可能な場合は true。それ以外の場合は false 

    • read

      T read(ResolvableType type, HttpInputMessage inputMessage, @Nullable MapSE<StringSE,ObjectSE> hints) throws IOExceptionSE, HttpMessageNotReadableException
      指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
      パラメーター:
      type - 返されるオブジェクトの (潜在的にジェネリクスな) 型。この型は、このインターフェースの canRead メソッドに以前に渡され、true を返している必要があります。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。
      inputMessage - 読み込む HTTP 入力メッセージ
      hints - エンコード方法に関する追加情報
      戻り値:
      変換されたオブジェクト
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotReadableException - 変換エラーの場合

    • read

      default T read(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException
      インターフェースからコピーされた説明: HttpMessageConverter
      指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
      次で指定:
      インターフェース HttpMessageConverter<T> の read 
      パラメーター:
      clazz - 返すオブジェクトの型。この型は、このインターフェースの canRead メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
      inputMessage - 読み込む HTTP 入力メッセージ
      戻り値:
      変換されたオブジェクト
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotReadableException - 変換エラーの場合

    • canWrite

      boolean canWrite(ResolvableType targetType, ClassSE<?> valueClass, @Nullable MediaType mediaType)
      指定されたクラスをこのコンバーターで書き込めるかどうかを示します。

      このメソッドは、ジェネリクス型に関連する追加のチェックを使用して HttpMessageConverter.canWrite(Class, MediaType) と同じチェックを実行する必要があります。

      パラメーター:
      targetType - 書き込み可能性をテストする (潜在的にジェネリクスな) ターゲット型 (指定されていない場合は ResolvableType.NONE になります)。関連する場合、型 ソースは追加情報 (関連するメソッドシグネチャーなど) を取得するために使用されることがあります。
      valueClass - 書き込み可能性をテストするソースオブジェクトクラス
      mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
      戻り値:
      書き込み可能な場合は true。それ以外の場合は false 

    • canWrite

      default boolean canWrite(ClassSE<?> clazz, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: HttpMessageConverter
      指定されたクラスをこのコンバーターで書き込めるかどうかを示します。
      次で指定:
      インターフェース HttpMessageConverter<T> の canWrite 
      パラメーター:
      clazz - 書き込み可能性をテストするクラス
      mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
      戻り値:
      書き込み可能な場合は true。それ以外の場合は false 

    • write

      void write(T t, ResolvableType type, @Nullable MediaType contentType, HttpOutputMessage outputMessage, @Nullable MapSE<StringSE,ObjectSE> hints) throws IOExceptionSE, HttpMessageNotWritableException
      指定されたオブジェクトを指定された出力メッセージに書き込みます。
      パラメーター:
      t - 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースの canWrite メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
      type - 書き込むオブジェクトの (潜在的にジェネリクスな) 型。この型は、このインターフェースの canWrite メソッドに以前に渡されている必要があり、true を返している必要があります。指定されていない場合は、ResolvableType.NONE にすることができます。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。
      contentType - 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示す null の場合があります。null でない場合、このメディア型は、このインターフェースの canWrite メソッドに事前に渡されている必要があり、true が返されている必要があります。
      outputMessage - 書き込むメッセージ
      hints - エンコード方法に関する追加情報
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotWritableException - 変換エラーの場合

    • write

      default void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException
      インターフェースからコピーされた説明: HttpMessageConverter
      指定されたオブジェクトを指定された出力メッセージに書き込みます。
      次で指定:
      インターフェース HttpMessageConverter<T> の write 
      パラメーター:
      t - 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースの canWrite メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
      contentType - 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示す null の場合があります。null でない場合、このメディア型は、このインターフェースの canWrite メソッドに事前に渡されている必要があり、true が返されている必要があります。
      outputMessage - 書き込むメッセージ
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotWritableException - 変換エラーの場合