クラス 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を構築します。protectedAbstractGenericHttpMessageConverter(MediaType supportedMediaType) サポートされている 1 つのメディア型でAbstractGenericHttpMessageConverterを構築します。protectedAbstractGenericHttpMessageConverter(MediaType... supportedMediaTypes) サポートされている複数のメディア型でAbstractGenericHttpMessageConverterを作成します。方法の概要
修飾子と型メソッド説明boolean指定された型がこのコンバーターで読み取れるかどうかを示します。boolean指定されたクラスをこのコンバーターで書き込めるかどうかを示します。protected boolean指定されたクラスがこのコンバーターでサポートされているかどうかを示します。final voidwrite(T t, TypeSE type, MediaType contentType, HttpOutputMessage outputMessage) protected abstract voidwriteInternal(T t, TypeSE type, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。protected voidwriteInternal(T t, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, readInternal, setDefaultCharset, setSupportedMediaTypes, 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
コンストラクターの詳細
AbstractGenericHttpMessageConverter
protected AbstractGenericHttpMessageConverter()サポートされているメディア型なしでAbstractGenericHttpMessageConverterを構築します。AbstractGenericHttpMessageConverter
サポートされている 1 つのメディア型でAbstractGenericHttpMessageConverterを構築します。- パラメーター:
supportedMediaType- サポートされているメディア型
AbstractGenericHttpMessageConverter
サポートされている複数のメディア型でAbstractGenericHttpMessageConverterを作成します。- パラメーター:
supportedMediaTypes- サポートされているメディア型
方法の詳細
supports
クラスからコピーされた説明: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
インターフェースからコピーされた説明: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- 変換エラーの場合