クラス ObjectToStringHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<ObjectSE>
org.springframework.http.converter.ObjectToStringHttpMessageConverter
- 実装されたすべてのインターフェース:
HttpMessageConverter<ObjectSE>
コンテンツの読み取りと書き込みに
StringHttpMessageConverter を使用する HttpMessageConverter と、文字列コンテンツのターゲットオブジェクト型との変換に ConversionService を使用します。 デフォルトでは、このコンバーターはメディア型 text/plain のみをサポートします。これは、supportedMediaTypes プロパティによってオーバーライドできます。
使用例:
<bean class="org.springframework.http.converter.ObjectToStringHttpMessageConverter">
<constructor-arg>
<bean class="org.springframework.context.support.ConversionServiceFactoryBean"/>
</constructor-arg>
</bean>
- 導入:
- 3.2
- 作成者:
- Dmitry Katsubo, Rossen Stoyanchev
フィールドサマリー
クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
loggerコンストラクターのサマリー
コンストラクターコンストラクター説明ObjectToStringHttpMessageConverter(ConversionService conversionService) （String）メッセージ本文とターゲットクラス型間の変換に使用するConversionServiceを受け入れるコンストラクター。ObjectToStringHttpMessageConverter(ConversionService conversionService, CharsetSE defaultCharset) ConversionServiceおよびデフォルトの文字セットを受け入れるコンストラクター。方法の概要
修飾子と型メソッド説明booleanこの実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。booleanprotected LongSEgetContentLength(ObjectSE obj, MediaType contentType) 指定された型のコンテンツの長さを返します。protected ObjectSEreadInternal(ClassSE<?> clazz, HttpInputMessage inputMessage) 実際のオブジェクトを読み取る抽象テンプレートメソッド。voidsetWriteAcceptCharset(boolean writeAcceptCharset) protected boolean指定されたクラスがこのコンバーターでサポートされているかどうかを示します。protected booleanこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。protected voidwriteInternal(ObjectSE obj, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canWrite, getDefaultCharset, getDefaultContentType, 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
コンストラクターの詳細
ObjectToStringHttpMessageConverter
（String）メッセージ本文とターゲットクラス型間の変換に使用するConversionServiceを受け入れるコンストラクター。このコンストラクターは、デフォルトの文字セットとしてStringHttpMessageConverter.DEFAULT_CHARSETを使用します。- パラメーター:
conversionService- 変換サービス
ObjectToStringHttpMessageConverter
public ObjectToStringHttpMessageConverter(ConversionService conversionService, CharsetSE defaultCharset) ConversionServiceおよびデフォルトの文字セットを受け入れるコンストラクター。- パラメーター:
conversionService- 変換サービスdefaultCharset- デフォルトの文字セット
メソッドの詳細
setWriteAcceptCharset
public void setWriteAcceptCharset(boolean writeAcceptCharset) canRead
クラスからコピーされた説明:AbstractHttpMessageConverterこの実装は、指定されたクラスがサポートされているかどうか、およびサポートされているメディア型 に指定されたメディア型が 含まれているかどうかをチェックします。- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>のcanRead - オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のcanRead - パラメーター:
clazz- 読み込み可能性をテストするクラスmediaType- 読み取るメディア型（指定しない場合はnullにできます）; 通常、Content-Typeヘッダーの値。- 戻り値:
- 読み取り可能な場合は
true。それ以外の場合はfalse
canWrite
クラスからコピーされた説明:AbstractHttpMessageConverter- 次で指定:
- インターフェース
HttpMessageConverter<ObjectSE>のcanWrite - オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のcanWrite - パラメーター:
clazz- 書き込み可能性をテストするクラスmediaType- 書き込むメディア型（指定しない場合はnullにすることができます）; 通常、Acceptヘッダーの値。- 戻り値:
- 書き込み可能な場合は
true。それ以外の場合はfalse
supports
クラスからコピーされた説明:AbstractHttpMessageConverter指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- 次で指定:
- クラス
AbstractHttpMessageConverter<ObjectSE>のsupports - パラメーター:
clazz- サポートをテストするクラス- 戻り値:
- サポートされている場合は
true。それ以外の場合はfalse
readInternal
protected ObjectSE 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- 変換エラーの場合
writeInternal
クラスからコピーされた説明:AbstractHttpMessageConverter実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)から呼び出されます。- 次で指定:
- クラス
AbstractHttpMessageConverter<ObjectSE>のwriteInternal - パラメーター:
obj- 出力メッセージに書き込むオブジェクトoutputMessage- 書き込む HTTP 出力メッセージ- 例外:
IOExceptionSE- I/O エラーの場合
getContentLength
クラスからコピーされた説明:AbstractHttpMessageConverter指定された型のコンテンツの長さを返します。デフォルトでは、これは
nullを返します。これは、コンテンツの長さが不明であることを意味します。サブクラスでオーバーライドできます。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のgetContentLength - パラメーター:
obj- コンテンツの長さを返す型- 戻り値:
- コンテンツの長さ、または不明の場合は
null
supportsRepeatableWrites
クラスからコピーされた説明:AbstractHttpMessageConverterこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。デフォルトの実装は
falseを返します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<ObjectSE>のsupportsRepeatableWrites - パラメーター:
o- オブジェクト t- 戻り値:
-
tを繰り返し書き込める場合はtrue。それ以外の場合はfalse