インターフェース HttpMessageConverter<T>
- 型パラメーター:
T
- 変換されたオブジェクト型
- すべての既知のサブインターフェース:
GenericHttpMessageConverter<T>
- すべての既知の実装クラス:
AbstractGenericHttpMessageConverter
、AbstractHttpMessageConverter
、AbstractJackson2HttpMessageConverter
、AbstractJaxb2HttpMessageConverter
、AbstractJsonHttpMessageConverter
、AbstractKotlinSerializationHttpMessageConverter
、AbstractWireFeedHttpMessageConverter
、AbstractXmlHttpMessageConverter
、AllEncompassingFormHttpMessageConverter
、AtomFeedHttpMessageConverter
、BufferedImageHttpMessageConverter
、ByteArrayHttpMessageConverter
、FormHttpMessageConverter
、GsonHttpMessageConverter
、Jaxb2CollectionHttpMessageConverter
、Jaxb2RootElementHttpMessageConverter
、JsonbHttpMessageConverter
、KotlinSerializationBinaryHttpMessageConverter
、KotlinSerializationCborHttpMessageConverter
、KotlinSerializationJsonHttpMessageConverter
、KotlinSerializationProtobufHttpMessageConverter
、KotlinSerializationStringHttpMessageConverter
、MappingJackson2CborHttpMessageConverter
、MappingJackson2HttpMessageConverter
、MappingJackson2SmileHttpMessageConverter
、MappingJackson2XmlHttpMessageConverter
、MarshallingHttpMessageConverter
、ObjectToStringHttpMessageConverter
、ProtobufHttpMessageConverter
、ProtobufJsonFormatHttpMessageConverter
、ResourceHttpMessageConverter
、ResourceRegionHttpMessageConverter
、RssChannelHttpMessageConverter
、SourceHttpMessageConverter
、StringHttpMessageConverter
public interface HttpMessageConverter<T>
HTTP リクエストおよびレスポンスとの間で変換するための戦略インターフェース。
- 導入:
- 3.0
- 作成者:
- Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev
メソッドのサマリー
修飾子と型メソッド説明boolean
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。boolean
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。このコンバーターでサポートされているメディア型のリストを返します。getSupportedMediaTypes
(ClassSE<?> clazz) 指定されたクラスについて、このコンバーターでサポートされているメディア型のリストを返します。read
(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。void
write
(T t, MediaType contentType, HttpOutputMessage outputMessage) 指定されたオブジェクトを指定された出力メッセージに書き込みます。
メソッドの詳細
canRead
指定されたクラスがこのコンバーターで読み取れるかどうかを示します。- パラメーター:
clazz
- 読み込み可能性をテストするクラスmediaType
- 読み取るメディア型(指定しない場合はnull
にできます); 通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canWrite
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。- パラメーター:
clazz
- 書き込み可能性をテストするクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
getSupportedMediaTypes
このコンバーターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(clazz, null
を介して保護する必要があります。このリストでは、特定のクラスでのみサポートされている MIME 型を除外することもできます。または、getSupportedMediaTypes(Class)
を使用してより正確なリストを作成します。- 戻り値:
- サポートされているメディア型のリスト
getSupportedMediaTypes
指定されたクラスについて、このコンバーターでサポートされているメディア型のリストを返します。コンバーターが特定のクラスをサポートしていない場合、またはメディア型のサブセットに対してのみサポートしている場合、リストはgetSupportedMediaTypes()
とは異なる場合があります。- パラメーター:
clazz
- チェックするクラスの型- 戻り値:
- 特定のクラスでサポートされているメディア型のリスト
- 導入:
- 5.3.4
read
T read(ClassSE<? extends T> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。- パラメーター:
clazz
- 返すオブジェクトの型。この型は、このインターフェースのcanRead
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
write
void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException 指定されたオブジェクトを指定された出力メッセージに書き込みます。- パラメーター:
t
- 出力メッセージに書き込むオブジェクト。このオブジェクトの型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。contentType
- 書き込み時に使用するコンテンツ型。コンバーターのデフォルトのコンテンツ型を使用する必要があることを示すnull
の場合があります。null
でない場合、このメディア型は、このインターフェースのcanWrite
メソッドに事前に渡されている必要があり、true
が返されている必要があります。outputMessage
- 書き込むメッセージ- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合