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

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

型パラメーター:
T - 変換されたオブジェクト型
すべてのスーパーインターフェース:
HttpMessageConverter<T>
すべての既知の実装クラス:
AbstractGenericHttpMessageConverter、AbstractJackson2HttpMessageConverter、AbstractJsonHttpMessageConverter、GsonHttpMessageConverter、Jaxb2CollectionHttpMessageConverter、JsonbHttpMessageConverter、MappingJackson2CborHttpMessageConverter、MappingJackson2HttpMessageConverter、MappingJackson2SmileHttpMessageConverter、MappingJackson2XmlHttpMessageConverter、MappingJackson2YamlHttpMessageConverter、ResourceRegionHttpMessageConverter
public interface GenericHttpMessageConverter<T> extends HttpMessageConverter<T>
HTTP リクエストを指定されたジェネリクス型のターゲットオブジェクトに変換し、指定されたジェネリクス型のソースオブジェクトを HTTP レスポンスに変換できる HttpMessageConverter の特殊化。
導入:
3.2
作成者:
Arjen Poutsma, Rossen Stoyanchev, Sebastien Deleuze
関連事項:

  • メソッドの詳細

    • canRead

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

    • read

      T read(TypeSE type, @Nullable ClassSE<?> contextClass, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException
      指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。
      パラメーター:
      type - 返される（潜在的に汎用の）型のオブジェクト。この型は、このインターフェースの canRead メソッドに事前に渡されている必要があります。このメソッドは true を返している必要があります。
      contextClass - ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null にすることができます)
      inputMessage - 読み込む HTTP 入力メッセージ
      戻り値:
      変換されたオブジェクト
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotReadableException - 変換エラーの場合

    • canWrite

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

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

      パラメーター:
      type - 書き込み可能かどうかをテストする（潜在的にジェネリクス）型 (指定しない場合は null にすることができます)
      clazz - 書き込み可能性をテストするソースオブジェクトクラス
      mediaType - 書き込むメディア型（指定しない場合は null にすることができます）; 通常、Accept ヘッダーの値。
      戻り値:
      書き込み可能な場合は true。それ以外の場合は false 
      導入:
      4.2

    • write

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