クラス AbstractSmartHttpMessageConverter<T>
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<T>
org.springframework.http.converter.AbstractSmartHttpMessageConverter<T>
- 型パラメーター:
T
- 変換されたオブジェクト型
- 実装されたすべてのインターフェース:
HttpMessageConverter<T>
,SmartHttpMessageConverter<T>
public abstract class AbstractSmartHttpMessageConverter<T>
extends AbstractHttpMessageConverter<T>
implements SmartHttpMessageConverter<T>
ほとんどの
SmartHttpMessageConverter
実装の抽象基本クラス。- 導入:
- 6.2
- 作成者:
- Sebastien Deleuze
フィールドサマリー
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクター修飾子コンストラクター説明protected
サポートされているメディア型なしでAbstractSmartHttpMessageConverter
を構築します。protected
AbstractSmartHttpMessageConverter
(MediaType supportedMediaType) サポートされている 1 つのメディア型でAbstractSmartHttpMessageConverter
を構築します。protected
AbstractSmartHttpMessageConverter
(MediaType... supportedMediaTypes) サポートされている複数のメディア型でAbstractSmartHttpMessageConverter
を作成します。方法の概要
修飾子と型メソッド説明boolean
canRead
(ResolvableType type, MediaType mediaType) 指定された型がこのコンバーターで読み取れるかどうかを示します。boolean
canWrite
(ResolvableType type, ClassSE<?> clazz, MediaType mediaType) 指定されたクラスをこのコンバーターで書き込めるかどうかを示します。protected T
readInternal
(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) 実際のオブジェクトを読み取る抽象テンプレートメソッド。protected boolean
指定されたクラスがこのコンバーターでサポートされているかどうかを示します。final void
write
(T t, ResolvableType type, MediaType contentType, HttpOutputMessage outputMessage, MapSE<StringSE, ObjectSE> hints) protected abstract void
writeInternal
(T t, ResolvableType type, HttpOutputMessage outputMessage, MapSE<StringSE, ObjectSE> hints) 実際の本文を書き込む抽象テンプレートメソッド。protected void
writeInternal
(T t, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, supportsRepeatableWrites, write
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes, getSupportedMediaTypes
コンストラクターの詳細
AbstractSmartHttpMessageConverter
protected AbstractSmartHttpMessageConverter()サポートされているメディア型なしでAbstractSmartHttpMessageConverter
を構築します。AbstractSmartHttpMessageConverter
サポートされている 1 つのメディア型でAbstractSmartHttpMessageConverter
を構築します。- パラメーター:
supportedMediaType
- サポートされているメディア型
AbstractSmartHttpMessageConverter
サポートされている複数のメディア型でAbstractSmartHttpMessageConverter
を作成します。- パラメーター:
supportedMediaTypes
- サポートされているメディア型
メソッドの詳細
supports
クラスからコピーされた説明:AbstractHttpMessageConverter
指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- 次で指定:
- クラス
AbstractHttpMessageConverter<T>
のsupports
- パラメーター:
clazz
- サポートをテストするクラス- 戻り値:
- サポートされている場合は
true
。それ以外の場合はfalse
canRead
インターフェースからコピーされた説明:SmartHttpMessageConverter
指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用してHttpMessageConverter.canRead(Class, MediaType)
と同じチェックを実行する必要があります。- 次で指定:
- インターフェース
SmartHttpMessageConverter<T>
のcanRead
- パラメーター:
type
- 読みやすさをテストする (潜在的にジェネリクスな) 型。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。mediaType
- 読み取るメディア型。指定されていない場合はnull
にすることができます。通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canWrite
インターフェースからコピーされた説明:SmartHttpMessageConverter
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用して
HttpMessageConverter.canWrite(Class, MediaType)
と同じチェックを実行する必要があります。- 次で指定:
- インターフェース
SmartHttpMessageConverter<T>
のcanWrite
- パラメーター:
type
- 書き込み可能性をテストする (潜在的にジェネリクスな) ターゲット型 (指定されていない場合はResolvableType.NONE
になります)。関連する場合、型 ソースは追加情報 (関連するメソッドシグネチャーなど) を取得するために使用されることがあります。clazz
- 書き込み可能性をテストするソースオブジェクトクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
write
public final void write(T t, ResolvableType type, @Nullable MediaType contentType, HttpOutputMessage outputMessage, @Nullable MapSE<StringSE, ObjectSE> hints) throws IOExceptionSE, HttpMessageNotWritableExceptionこの実装は、AbstractHttpMessageConverter.addDefaultHeaders(org.springframework.http.HttpHeaders, T, org.springframework.http.MediaType)
を呼び出してデフォルトのヘッダーを設定し、次にwriteInternal(T, org.springframework.http.HttpOutputMessage)
を呼び出します。- 次で指定:
- インターフェース
SmartHttpMessageConverter<T>
のwrite
- パラメーター:
t
- 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。type
- 書き込むオブジェクトの (潜在的にジェネリクスな) 型。この型は、このインターフェースのcanWrite
メソッドに以前に渡されている必要があり、true
を返している必要があります。指定されていない場合は、ResolvableType.NONE
にすることができます。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。contentType
- 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示すnull
の場合があります。null
でない場合、このメディア型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があり、true
が返されている必要があります。outputMessage
- 書き込むメッセージhints
- エンコード方法に関する追加情報- 例外:
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, ResolvableType type, HttpOutputMessage outputMessage, @Nullable MapSE<StringSE, ObjectSE> hints) throws IOExceptionSE, HttpMessageNotWritableException実際の本文を書き込む抽象テンプレートメソッド。write(Object, ResolvableType, MediaType, HttpOutputMessage, Map)
から呼び出されます。- パラメーター:
t
- 出力メッセージに書き込むオブジェクトtype
- 書き込むオブジェクトの型outputMessage
- 書き込む HTTP 出力メッセージhints
- エンコード方法に関する追加情報- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合
readInternal
protected T readInternal(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException クラスからコピーされた説明:AbstractHttpMessageConverter
実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
から呼び出されます。- 次で指定:
- クラス
AbstractHttpMessageConverter<T>
のreadInternal
- パラメーター:
clazz
- 返すオブジェクトの型inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合