クラス AbstractGenericHttpMessageConverter<T>

java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<T>
org.springframework.http.converter.AbstractGenericHttpMessageConverter<T>
型パラメーター:
T - 変換されたオブジェクト型
実装されているすべてのインターフェース:
GenericHttpMessageConverter<T>, HttpMessageConverter<T>
既知の直属サブクラス
AbstractJackson2HttpMessageConverter, AbstractJsonHttpMessageConverter, ResourceRegionHttpMessageConverter
public abstract class AbstractGenericHttpMessageConverter<T> extends AbstractHttpMessageConverter<T> implements GenericHttpMessageConverter<T>
ほとんどの GenericHttpMessageConverter 実装の抽象基本クラス。
導入:
4.2
作成者:
Sebastien Deleuze, Juergen Hoeller

  • コンストラクターの詳細

    • AbstractGenericHttpMessageConverter

      protected AbstractGenericHttpMessageConverter()
      サポートされているメディア型なしで AbstractGenericHttpMessageConverter を構築します。
      関連事項:

    • AbstractGenericHttpMessageConverter

      protected AbstractGenericHttpMessageConverter(MediaType supportedMediaType)
      サポートされている 1 つのメディア型で AbstractGenericHttpMessageConverter を構築します。
      パラメーター:
      supportedMediaType - サポートされているメディア型

    • AbstractGenericHttpMessageConverter

      protected AbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes)
      サポートされている複数のメディア型で AbstractGenericHttpMessageConverter を作成します。
      パラメーター:
      supportedMediaTypes - サポートされているメディア型

    • AbstractGenericHttpMessageConverter

      protected AbstractGenericHttpMessageConverter(CharsetSE defaultCharset, MediaType... supportedMediaTypes)
      デフォルトの文字セットとサポートされている複数のメディア型で AbstractGenericHttpMessageConverter を構築します。
      パラメーター:
      defaultCharset - デフォルトの文字セットです
      supportedMediaTypes - サポートされているメディア型
      導入:
      6.2

  • メソッドの詳細

    • supports

      protected boolean supports(ClassSE<?> clazz)
      クラスからコピーされた説明: AbstractHttpMessageConverter
      指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
      次で指定:
      クラス AbstractHttpMessageConverter<T> の supports 
      パラメーター:
      clazz - サポートをテストするクラス
      戻り値:
      サポートされている場合は true。それ以外の場合は false 

    • canRead

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

    • canWrite

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

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

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

    • write

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

    • writeInternal

      protected void writeInternal(T t, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException
      クラスからコピーされた説明: AbstractHttpMessageConverter
      実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, MediaType, HttpOutputMessage) から呼び出されます。
      次で指定:
      クラス AbstractHttpMessageConverter<T> の writeInternal 
      パラメーター:
      t - 出力メッセージに書き込むオブジェクト
      outputMessage - 書き込む HTTP 出力メッセージ
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotWritableException - 変換エラーの場合

    • writeInternal

      protected abstract void writeInternal(T t, @Nullable TypeSE type, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException
      実際の本文を書き込む抽象テンプレートメソッド。write(T, Type, MediaType, HttpOutputMessage) から呼び出されます。
      パラメーター:
      t - 出力メッセージに書き込むオブジェクト
      type - 書き込むオブジェクトの型 (null の場合があります)
      outputMessage - 書き込む HTTP 出力メッセージ
      例外:
      IOExceptionSE - I/O エラーの場合
      HttpMessageNotWritableException - 変換エラーの場合