クラス AbstractGenericHttpMessageConverter<T>
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<T>
org.springframework.http.converter.AbstractGenericHttpMessageConverter<T>
- 型パラメーター:
- T- 変換されたオブジェクト型
- 実装されているすべてのインターフェース:
- GenericHttpMessageConverter<T>,- HttpMessageConverter<T>
- 既知の直属サブクラス
- AbstractJackson2HttpMessageConverter、- AbstractJsonHttpMessageConverter、- AbstractKotlinSerializationHttpMessageConverter、- 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を構築します。- protected- AbstractGenericHttpMessageConverter- (MediaType supportedMediaType) サポートされている 1 つのメディア型で- AbstractGenericHttpMessageConverterを構築します。- protected- AbstractGenericHttpMessageConverter- (MediaType... supportedMediaTypes) サポートされている複数のメディア型で- AbstractGenericHttpMessageConverterを作成します。
- メソッドのサマリー修飾子と型メソッド説明- boolean指定された型がこのコンバーターで読み取れるかどうかを示します。- boolean指定されたクラスをこのコンバーターで書き込めるかどうかを示します。- protected boolean指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- final void- write- (T t, TypeSE type, MediaType contentType, HttpOutputMessage outputMessage) - protected abstract void- writeInternal- (T t, TypeSE type, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。- protected void- writeInternal- (T t, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。- クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド- addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, readInternal, setDefaultCharset, setSupportedMediaTypes, supportsRepeatableWrites, write- クラス java.lang.ObjectSE から継承されたメソッド- clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE- インターフェース org.springframework.http.converter.GenericHttpMessageConverter から継承されたメソッド- read- インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド- canRead, canWrite, getSupportedMediaTypes, getSupportedMediaTypes, read, write
- コンストラクターの詳細- AbstractGenericHttpMessageConverterprotected AbstractGenericHttpMessageConverter()サポートされているメディア型なしで- AbstractGenericHttpMessageConverterを構築します。
- AbstractGenericHttpMessageConverterサポートされている 1 つのメディア型で- AbstractGenericHttpMessageConverterを構築します。- パラメーター:
- supportedMediaType- サポートされているメディア型
 
- AbstractGenericHttpMessageConverterサポートされている複数のメディア型で- AbstractGenericHttpMessageConverterを作成します。- パラメーター:
- supportedMediaTypes- サポートされているメディア型
 
 
- メソッドの詳細- supportsクラスからコピーされた説明:- AbstractHttpMessageConverter指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- 次で指定:
-  クラス AbstractHttpMessageConverter<T>のsupports
- パラメーター:
- clazz- サポートをテストするクラス
- 戻り値:
-  サポートされている場合は true。それ以外の場合はfalse
 
- canReadpublic 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インターフェースからコピーされた説明:- GenericHttpMessageConverter指定されたクラスをこのコンバーターで書き込めるかどうかを示します。- このメソッドは、ジェネリクス型に関連する追加のチェックを使用して - HttpMessageConverter.canWrite(Class, MediaType)と同じチェックを実行する必要があります。- 次で指定:
-  インターフェース GenericHttpMessageConverter<T>のcanWrite
- パラメーター:
- type- 書き込み可能かどうかをテストする(潜在的にジェネリクス)型 (指定しない場合は- nullにすることができます)
- clazz- 書き込み可能性をテストするソースオブジェクトクラス
- mediaType- 書き込むメディア型(指定しない場合は- nullにすることができます); 通常、- Acceptヘッダーの値。
- 戻り値:
-  書き込み可能な場合は true。それ以外の場合はfalse
 
- writepublic 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- 変換エラーの場合
 
- writeInternalprotected 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- 変換エラーの場合
 
- writeInternalprotected 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- 変換エラーの場合