インターフェース SmartHttpMessageConverter<T>
- 型パラメーター:
T
- 変換されたオブジェクト型
- すべてのスーパーインターフェース:
HttpMessageConverter<T>
- すべての既知の実装クラス:
AbstractKotlinSerializationHttpMessageConverter
、AbstractSmartHttpMessageConverter
、KotlinSerializationBinaryHttpMessageConverter
、KotlinSerializationCborHttpMessageConverter
、KotlinSerializationJsonHttpMessageConverter
、KotlinSerializationProtobufHttpMessageConverter
、KotlinSerializationStringHttpMessageConverter
HttpMessageConverter
の特殊化であり、HTTP リクエストを指定された ResolvableType
のターゲットオブジェクトに変換し、指定された ResolvableType
のソースオブジェクトをオプションのヒントを含む HTTP レスポンスに変換できます。 サブクラスがスマート API のみを実装できるように、HttpMessageConverter
のデフォルトメソッドを提供します。
- 導入:
- 6.2
- 作成者:
- Sebastien Deleuze
方法の概要
修飾子と型メソッド説明default boolean
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。boolean
canRead
(ResolvableType type, MediaType mediaType) 指定された型がこのコンバーターで読み取れるかどうかを示します。default boolean
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。boolean
canWrite
(ResolvableType targetType, ClassSE<?> valueClass, MediaType mediaType) 指定されたクラスをこのコンバーターで書き込めるかどうかを示します。default T
read
(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。read
(ResolvableType type, HttpInputMessage inputMessage, MapSE<StringSE, ObjectSE> hints) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。void
write
(T t, ResolvableType type, MediaType contentType, HttpOutputMessage outputMessage, MapSE<StringSE, ObjectSE> hints) 指定されたオブジェクトを指定された出力メッセージに書き込みます。default void
write
(T t, MediaType contentType, HttpOutputMessage outputMessage) 指定されたオブジェクトを指定された出力メッセージに書き込みます。インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes, getSupportedMediaTypes
メソッドの詳細
canRead
指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用してHttpMessageConverter.canRead(Class, MediaType)
と同じチェックを実行する必要があります。- パラメーター:
type
- 読みやすさをテストする (潜在的にジェネリクスな) 型。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。mediaType
- 読み取るメディア型。指定されていない場合はnull
にすることができます。通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canRead
インターフェースからコピーされた説明:HttpMessageConverter
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。- 次で指定:
- インターフェース
HttpMessageConverter<T>
のcanRead
- パラメーター:
clazz
- 読み込み可能性をテストするクラスmediaType
- 読み取るメディア型(指定しない場合はnull
にできます); 通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
read
T read(ResolvableType type, HttpInputMessage inputMessage, @Nullable MapSE<StringSE, ObjectSE> hints) throws IOExceptionSE, HttpMessageNotReadableException指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。- パラメーター:
type
- 返されるオブジェクトの (潜在的にジェネリクスな) 型。この型は、このインターフェースのcanRead
メソッドに以前に渡され、true
を返している必要があります。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。inputMessage
- 読み込む HTTP 入力メッセージhints
- エンコード方法に関する追加情報- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
read
default T read(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException インターフェースからコピーされた説明:HttpMessageConverter
指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。- 次で指定:
- インターフェース
HttpMessageConverter<T>
のread
- パラメーター:
clazz
- 返すオブジェクトの型。この型は、このインターフェースのcanRead
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
canWrite
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用して
HttpMessageConverter.canWrite(Class, MediaType)
と同じチェックを実行する必要があります。- パラメーター:
targetType
- 書き込み可能性をテストする (潜在的にジェネリクスな) ターゲット型 (指定されていない場合はResolvableType.NONE
になります)。関連する場合、型 ソースは追加情報 (関連するメソッドシグネチャーなど) を取得するために使用されることがあります。valueClass
- 書き込み可能性をテストするソースオブジェクトクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
canWrite
インターフェースからコピーされた説明:HttpMessageConverter
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。- 次で指定:
- インターフェース
HttpMessageConverter<T>
のcanWrite
- パラメーター:
clazz
- 書き込み可能性をテストするクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
write
void write(T t, ResolvableType type, @Nullable MediaType contentType, HttpOutputMessage outputMessage, @Nullable MapSE<StringSE, ObjectSE> hints) throws IOExceptionSE, HttpMessageNotWritableException指定されたオブジェクトを指定された出力メッセージに書き込みます。- パラメーター:
t
- 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。type
- 書き込むオブジェクトの (潜在的にジェネリクスな) 型。この型は、このインターフェースのcanWrite
メソッドに以前に渡されている必要があり、true
を返している必要があります。指定されていない場合は、ResolvableType.NONE
にすることができます。型ソースは、関連する場合、追加情報 (たとえば、関連するメソッドシグネチャー) を取得するために使用されることがあります。contentType
- 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示すnull
の場合があります。null
でない場合、このメディア型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があり、true
が返されている必要があります。outputMessage
- 書き込むメッセージhints
- エンコード方法に関する追加情報- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合
write
default void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException インターフェースからコピーされた説明:HttpMessageConverter
指定されたオブジェクトを指定された出力メッセージに書き込みます。- 次で指定:
- インターフェース
HttpMessageConverter<T>
のwrite
- パラメーター:
t
- 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。contentType
- 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示すnull
の場合があります。null
でない場合、このメディア型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があり、true
が返されている必要があります。outputMessage
- 書き込むメッセージ- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合