AbstractGenericHttpMessageConverter (Spring Framework API)

java.lang.ObjectSE
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- - org.springframework.http.converter.AbstractGenericHttpMessageConverter<T>

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

フィールドサマリー
- クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
  logger

コンストラクターのサマリー

コンストラクター
修飾子	コンストラクターと説明
`protected`	`AbstractGenericHttpMessageConverter()` サポートされているメディア型なしで `AbstractGenericHttpMessageConverter` を構築します。
`protected`	`AbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes)` サポートされている複数のメディア型で `AbstractGenericHttpMessageConverter` を作成します。
`protected`	`AbstractGenericHttpMessageConverter(MediaType supportedMediaType)` サポートされている 1 つのメディア型で `AbstractGenericHttpMessageConverter` を構築します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(TypeSE type, ClassSE<?> contextClass, MediaType mediaType)` 指定された型がこのコンバーターで読み取れるかどうかを示します。
`boolean`	`canWrite(TypeSE type, ClassSE<?> clazz, MediaType mediaType)` 指定されたクラスをこのコンバーターで書き込めるかどうかを示します。
`protected boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`void`	`write(T t, TypeSE type, MediaType contentType, HttpOutputMessage outputMessage)` この実装は、`AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)` を呼び出してデフォルトのヘッダーを設定し、次に `writeInternal(T, org.springframework.http.HttpOutputMessage)` を呼び出します。
`protected void`	`writeInternal(T t, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。
`protected abstract void`	`writeInternal(T t, TypeSE type, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, readInternal, setDefaultCharset, setSupportedMediaTypes, write

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

インターフェース org.springframework.http.converter.GenericHttpMessageConverter から継承されたメソッド
read

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
canRead, canWrite, getSupportedMediaTypes, getSupportedMediaTypes, read, write

- コンストラクターの詳細
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter()
```
    サポートされているメディア型なしで AbstractGenericHttpMessageConverter を構築します。
    関連事項:
    AbstractHttpMessageConverter.setSupportedMediaTypes(java.util.List<org.springframework.http.MediaType>)
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter(MediaType supportedMediaType)
```
    サポートされている 1 つのメディア型で AbstractGenericHttpMessageConverter を構築します。
    パラメーター:
    supportedMediaType - サポートされているメディア型
  - AbstractGenericHttpMessageConverter
```
protected AbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes)
```
    サポートされている複数のメディア型で AbstractGenericHttpMessageConverter を作成します。
    パラメーター:
    supportedMediaTypes - サポートされているメディア型
- メソッドの詳細
  - 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(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType) を呼び出してデフォルトのヘッダーを設定し、次に writeInternal(T, org.springframework.http.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, org.springframework.http.MediaType, org.springframework.http.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, java.lang.reflect.Type, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    パラメーター:
    t - 出力メッセージに書き込むオブジェクト
    type - 書き込むオブジェクトの型 (null の場合があります)
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    IOExceptionSE - I/O エラーの場合
    HttpMessageNotWritableException - 変換エラーの場合

クラス AbstractGenericHttpMessageConverter<T>

フィールドサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.http.converter.GenericHttpMessageConverter から継承されたメソッド

インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド

コンストラクターの詳細

AbstractGenericHttpMessageConverter

AbstractGenericHttpMessageConverter

AbstractGenericHttpMessageConverter

メソッドの詳細

supports

canRead

canWrite

write

writeInternal

writeInternal