クラス StringHttpMessageConverter
java.lang.ObjectSE
org.springframework.http.converter.AbstractHttpMessageConverter<StringSE>
org.springframework.http.converter.StringHttpMessageConverter
- 実装されているすべてのインターフェース:
HttpMessageConverter<StringSE>
文字列を読み書きできる
HttpMessageConverter の実装。 デフォルトでは、このコンバーターはすべてのメディア型(*/*)をサポートし、text/plain の Content-Type で書き込みます。これは、supportedMediaTypes プロパティを設定することでオーバーライドできます。
- 導入:
- 3.0
- 作成者:
- Arjen Poutsma, Juergen Hoeller
フィールドのサマリー
フィールドクラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
loggerコンストラクターの概要
コンストラクターコンストラクター説明"ISO-8859-1"をデフォルトの文字セットとして使用するデフォルトのコンストラクター。StringHttpMessageConverter(CharsetSE defaultCharset) リクエストされたコンテンツ型で指定されていない場合に使用するデフォルトの文字セットを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明protected voidaddDefaultHeaders(HttpHeaders headers, StringSE s, MediaType type) 出力メッセージにデフォルトのヘッダーを追加します。サポートされているCharsetsSE のリストを返します。protected LongSEgetContentLength(StringSE str, MediaType contentType) 指定された型のコンテンツの長さを返します。protected StringSEreadInternal(ClassSE<? extends StringSE> clazz, HttpInputMessage inputMessage) 実際のオブジェクトを読み取る抽象テンプレートメソッド。voidsetWriteAcceptCharset(boolean writeAcceptCharset) Charset.availableCharsets()の値をソースとする発信リクエストにAccept-Charsetヘッダーを書き込む必要があるかどうか。boolean指定されたクラスがこのコンバーターでサポートされているかどうかを示します。protected booleanこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。protected voidwriteInternal(StringSE str, HttpOutputMessage outputMessage) 実際の本文を書き込む抽象テンプレートメソッド。クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
canRead, canRead, canWrite, 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
フィールドの詳細
DEFAULT_CHARSET
コンバーターが使用するデフォルトの文字セット。
コンストラクターの詳細
StringHttpMessageConverter
public StringHttpMessageConverter()"ISO-8859-1"をデフォルトの文字セットとして使用するデフォルトのコンストラクター。StringHttpMessageConverter
リクエストされたコンテンツ型で指定されていない場合に使用するデフォルトの文字セットを受け入れるコンストラクター。
メソッドの詳細
setWriteAcceptCharset
public void setWriteAcceptCharset(boolean writeAcceptCharset) Charset.availableCharsets()の値をソースとする発信リクエストにAccept-Charsetヘッダーを書き込む必要があるかどうか。ヘッダーがすでに設定されている場合、動作は抑制されます。5.2 現在、デフォルトでは
falseに設定されています。supports
クラスからコピーされた説明:AbstractHttpMessageConverter指定されたクラスがこのコンバーターでサポートされているかどうかを示します。- 次で指定:
- クラス
AbstractHttpMessageConverter<StringSE>のsupports - パラメーター:
clazz- サポートをテストするクラス- 戻り値:
- サポートされている場合は
true。それ以外の場合はfalse
readInternal
protected StringSE readInternal(ClassSE<? extends StringSE> clazz, HttpInputMessage inputMessage) throws IOExceptionSE クラスからコピーされた説明:AbstractHttpMessageConverter実際のオブジェクトを読み取る抽象テンプレートメソッド。AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, org.springframework.http.HttpInputMessage)から呼び出されます。- 次で指定:
- クラス
AbstractHttpMessageConverter<StringSE>のreadInternal - パラメーター:
clazz- 返すオブジェクトの型inputMessage- 読み込む HTTP 入力メッセージ- 戻り値:
- 変換されたオブジェクト
- 例外:
IOExceptionSE- I/O エラーの場合
getContentLength
クラスからコピーされた説明:AbstractHttpMessageConverter指定された型のコンテンツの長さを返します。デフォルトでは、これは
nullを返します。これは、コンテンツの長さが不明であることを意味します。サブクラスでオーバーライドできます。- オーバーライド:
- クラス
AbstractHttpMessageConverter<StringSE>のgetContentLength - パラメーター:
str- コンテンツの長さを返す型- 戻り値:
- コンテンツの長さ、または不明の場合は
null
addDefaultHeaders
protected void addDefaultHeaders(HttpHeaders headers, StringSE s, @Nullable MediaType type) throws IOExceptionSE クラスからコピーされた説明:AbstractHttpMessageConverter出力メッセージにデフォルトのヘッダーを追加します。この実装は、コンテンツ型が提供されない場合は
AbstractHttpMessageConverter.getDefaultContentType(Object)に委譲し、必要に応じてデフォルトの文字セットを設定し、AbstractHttpMessageConverter.getContentLength(T, org.springframework.http.MediaType)を呼び出し、対応するヘッダーを設定します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<StringSE>のaddDefaultHeaders - 例外:
IOExceptionSE
writeInternal
クラスからコピーされた説明:AbstractHttpMessageConverter実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage)から呼び出されます。- 次で指定:
- クラス
AbstractHttpMessageConverter<StringSE>のwriteInternal - パラメーター:
str- 出力メッセージに書き込むオブジェクトoutputMessage- 書き込む HTTP 出力メッセージ- 例外:
IOExceptionSE- I/O エラーの場合
getAcceptedCharsets
サポートされているCharsetsSE のリストを返します。デフォルトでは、
Charset.availableCharsets()を返します。サブクラスでオーバーライドできます。- 戻り値:
- 受け入れられた文字セットのリスト
supportsRepeatableWrites
クラスからコピーされた説明:AbstractHttpMessageConverterこのメッセージコンバーターが指定されたオブジェクトを複数回書き込むことができるかどうかを示します。デフォルトの実装は
falseを返します。- オーバーライド:
- クラス
AbstractHttpMessageConverter<StringSE>のsupportsRepeatableWrites - パラメーター:
s- オブジェクト t- 戻り値:
-
tを繰り返し書き込める場合はtrue。それ以外の場合はfalse