クラス ResourceRegionHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<T>
org.springframework.http.converter.AbstractGenericHttpMessageConverter<ObjectSE>
org.springframework.http.converter.ResourceRegionHttpMessageConverter
- 実装されたすべてのインターフェース:
GenericHttpMessageConverter<ObjectSE>
,HttpMessageConverter<ObjectSE>
public class ResourceRegionHttpMessageConverter
extends AbstractGenericHttpMessageConverter<ObjectSE>
- 導入:
- 4.3
- 作成者:
- Brian Clozel, Juergen Hoeller, Sam Brannen
フィールドサマリー
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明boolean
この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。boolean
指定された型がこのコンバーターで読み取れるかどうかを示します。boolean
boolean
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。protected MediaType
getDefaultContentType
(ObjectSE object) 指定された型のデフォルトのコンテンツ型を返します。read
(TypeSE type, ClassSE<?> contextClass, HttpInputMessage inputMessage) 指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。protected ResourceRegion
readInternal
(ClassSE<?> clazz, HttpInputMessage inputMessage) 実際のオブジェクトを読み取る抽象テンプレートメソッド。protected void
writeInternal
(ObjectSE object, TypeSE type, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。protected void
writeResourceRegion
(ResourceRegion region, HttpOutputMessage outputMessage) クラス org.springframework.http.converter.AbstractGenericHttpMessageConverter から継承されたメソッド
supports, write, writeInternal
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.converter.HttpMessageConverter から継承されたメソッド
getSupportedMediaTypes, getSupportedMediaTypes, read, write
コンストラクターの詳細
ResourceRegionHttpMessageConverter
public ResourceRegionHttpMessageConverter()
メソッドの詳細
getDefaultContentType
クラスからコピーされた説明:AbstractHttpMessageConverter
指定された型のデフォルトのコンテンツ型を返します。指定されたコンテンツ型パラメーターなしでAbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
が呼び出されたときに呼び出されます。デフォルトでは、
supportedMediaTypes
プロパティの最初の要素があれば、それを返します。サブクラスでオーバーライドできます。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>
のgetDefaultContentType
- パラメーター:
object
- コンテンツ型を返す型- 戻り値:
- コンテンツ型、または不明の場合は
null
canRead
クラスからコピーされた説明:AbstractHttpMessageConverter
この実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>
のcanRead
- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>
のcanRead
- パラメーター:
clazz
- 読み込み可能性をテストするクラスmediaType
- 読み取るメディア型(指定しない場合はnull
にできます); 通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
canRead
public boolean canRead(TypeSE type, @Nullable ClassSE<?> contextClass, @Nullable MediaType mediaType) インターフェースからコピーされた説明:GenericHttpMessageConverter
指定された型がこのコンバーターで読み取れるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用してHttpMessageConverter.canRead(Class, MediaType)
と同じチェックを実行する必要があります。- 次で指定:
- インターフェース
GenericHttpMessageConverter<ObjectSE>
のcanRead
- オーバーライド:
- クラス
AbstractGenericHttpMessageConverter<ObjectSE>
のcanRead
- パラメーター:
type
- 読みやすさをテストするための(潜在的に汎用)型contextClass
- ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null
にすることができます)mediaType
- 読み取るメディア型。指定されていない場合はnull
にすることができます。通常、Content-Type
ヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true
。それ以外の場合はfalse
read
public ObjectSE read(TypeSE type, @Nullable ClassSE<?> contextClass, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException インターフェースからコピーされた説明:GenericHttpMessageConverter
指定された入力メッセージから指定された型のオブジェクトを読み取り、それを返します。- パラメーター:
type
- 返される(潜在的に汎用の)型のオブジェクト。この型は、このインターフェースのcanRead
メソッドに事前に渡されている必要があります。このメソッドはtrue
を返している必要があります。contextClass
- ターゲット型のコンテキストクラス。たとえば、ターゲット型がメソッドシグネチャーに表示されるクラス (null
にすることができます)inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
readInternal
protected ResourceRegion readInternal(ClassSE<?> clazz, HttpInputMessage inputMessage) throws IOExceptionSE, HttpMessageNotReadableException クラスからコピーされた説明:AbstractHttpMessageConverter
実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)
から呼び出されます。- 次で指定:
- クラス
AbstractHttpMessageConverter<ObjectSE>
のreadInternal
- パラメーター:
clazz
- 返すオブジェクトの型inputMessage
- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotReadableException
- 変換エラーの場合
canWrite
クラスからコピーされた説明:AbstractHttpMessageConverter
- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>
のcanWrite
- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>
のcanWrite
- パラメーター:
clazz
- 書き込み可能性をテストするクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
canWrite
public boolean canWrite(@Nullable TypeSE type, @Nullable ClassSE<?> clazz, @Nullable MediaType mediaType) インターフェースからコピーされた説明:GenericHttpMessageConverter
指定されたクラスをこのコンバーターで書き込めるかどうかを示します。このメソッドは、ジェネリクス型に関連する追加のチェックを使用して
HttpMessageConverter.canWrite(Class, MediaType)
と同じチェックを実行する必要があります。- 次で指定:
- インターフェース
GenericHttpMessageConverter<ObjectSE>
のcanWrite
- オーバーライド:
- クラス
AbstractGenericHttpMessageConverter<ObjectSE>
のcanWrite
- パラメーター:
type
- 書き込み可能かどうかをテストする(潜在的にジェネリクス)型 (指定しない場合はnull
にすることができます)clazz
- 書き込み可能性をテストするソースオブジェクトクラスmediaType
- 書き込むメディア型(指定しない場合はnull
にすることができます); 通常、Accept
ヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true
。それ以外の場合はfalse
writeInternal
protected void writeInternal(ObjectSE object, @Nullable TypeSE type, HttpOutputMessage outputMessage) throws IOExceptionSE, HttpMessageNotWritableException クラスからコピーされた説明:AbstractGenericHttpMessageConverter
実際の本文を書き込む抽象テンプレートメソッド。AbstractGenericHttpMessageConverter.write(T, java.lang.reflect.Type, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)
から呼び出されます。- 次で指定:
- クラス
AbstractGenericHttpMessageConverter<ObjectSE>
のwriteInternal
- パラメーター:
object
- 出力メッセージに書き込むオブジェクトtype
- 書き込むオブジェクトの型 (null
の場合があります)outputMessage
- 書き込む HTTP 出力メッセージ- 例外:
IOExceptionSE
- I/O エラーの場合HttpMessageNotWritableException
- 変換エラーの場合
writeResourceRegion
protected void writeResourceRegion(ResourceRegion region, HttpOutputMessage outputMessage) throws IOExceptionSE