StringHttpMessageConverter (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.http.converter.AbstractHttpMessageConverter<StringSE>
- - org.springframework.http.converter.StringHttpMessageConverter

実装されたすべてのインターフェース:
HttpMessageConverter<StringSE>
```
public class StringHttpMessageConverter
extends AbstractHttpMessageConverter<StringSE>
```
文字列を読み書きできる HttpMessageConverter の実装。
デフォルトでは、このコンバーターはすべてのメディア型（*/*）をサポートし、text/plain の Content-Type で書き込みます。これは、supportedMediaTypes プロパティを設定することでオーバーライドできます。
導入:
3.0
作成者:
Arjen Poutsma, Juergen Hoeller

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
static CharsetSE DEFAULT_CHARSET
- クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド
  logger

フィールド
修飾子と型	フィールドと説明
`static CharsetSE`	`DEFAULT_CHARSET`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`StringHttpMessageConverter()` `"ISO-8859-1"` をデフォルトの文字セットとして使用するデフォルトのコンストラクター。
`StringHttpMessageConverter(CharsetSE defaultCharset)` リクエストされたコンテンツ型で指定されていない場合に使用するデフォルトの文字セットを受け入れるコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected ListSE<CharsetSE>`	`getAcceptedCharsets()` サポートされている `Charset`SE のリストを返します。
`protected LongSE`	`getContentLength(StringSE str, MediaType contentType)` 指定された型のコンテンツの長さを返します。
`protected StringSE`	`readInternal(ClassSE<? extends StringSE> clazz, HttpInputMessage inputMessage)` 実際のオブジェクトを読み取る抽象テンプレートメソッド。
`void`	`setWriteAcceptCharset(boolean writeAcceptCharset)` `Accept-Charset` を発信リクエストに書き込む必要があるかどうかを示します。
`boolean`	`supports(ClassSE<?> clazz)` 指定されたクラスがこのコンバーターでサポートされているかどうかを示します。
`protected void`	`writeInternal(StringSE str, HttpOutputMessage outputMessage)` 実際の本文を書き込む抽象テンプレートメソッド。

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド
addDefaultHeaders, canRead, canRead, canWrite, canWrite, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - DEFAULT_CHARSET
```
public static final CharsetSE DEFAULT_CHARSET
```
- コンストラクターの詳細
  - StringHttpMessageConverter
```
public StringHttpMessageConverter()
```
    "ISO-8859-1" をデフォルトの文字セットとして使用するデフォルトのコンストラクター。
    関連事項:
    StringHttpMessageConverter(Charset)
  - StringHttpMessageConverter
```
public StringHttpMessageConverter(CharsetSE defaultCharset)
```
    リクエストされたコンテンツ型で指定されていない場合に使用するデフォルトの文字セットを受け入れるコンストラクター。
- メソッドの詳細
  - setWriteAcceptCharset
```
public void setWriteAcceptCharset(boolean writeAcceptCharset)
```
    Accept-Charset を発信リクエストに書き込む必要があるかどうかを示します。
    デフォルトは true です。
  - supports
```
public boolean supports(ClassSE<?> clazz)
```
    クラスからコピーされた説明: 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
```
protected LongSE getContentLength(StringSE str,
                                @Nullable
                                MediaType contentType)
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    指定された型のコンテンツの長さを返します。
    デフォルトでは、これは null を返します。これは、コンテンツの長さが不明であることを意味します。サブクラスでオーバーライドできます。
    オーバーライド:
    クラス AbstractHttpMessageConverter<StringSE> の getContentLength
    パラメーター:
    str - コンテンツの長さを返す型
    戻り値:
    コンテンツの長さ、または不明の場合は null
  - writeInternal
```
protected void writeInternal(StringSE str,
                             HttpOutputMessage outputMessage)
                      throws IOExceptionSE
```
    クラスからコピーされた説明: AbstractHttpMessageConverter
    実際の本文を書き込む抽象テンプレートメソッド。AbstractHttpMessageConverter.write(T, org.springframework.http.MediaType, org.springframework.http.HttpOutputMessage) から呼び出されます。
    次で指定:
    クラス AbstractHttpMessageConverter<StringSE> の writeInternal
    パラメーター:
    str - 出力メッセージに書き込むオブジェクト
    outputMessage - 書き込む HTTP 出力メッセージ
    例外:
    IOExceptionSE - I/O エラーの場合
  - getAcceptedCharsets
```
protected ListSE<CharsetSE> getAcceptedCharsets()
```
    サポートされている CharsetSE のリストを返します。
    デフォルトでは、Charset.availableCharsets()SE を返します。サブクラスでオーバーライドできます。
    戻り値:
    受け入れられた文字セットのリスト

クラス StringHttpMessageConverter

フィールドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたフィールド

コンストラクターの概要

メソッドのサマリー

クラス org.springframework.http.converter.AbstractHttpMessageConverter から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

DEFAULT_CHARSET

コンストラクターの詳細

StringHttpMessageConverter

StringHttpMessageConverter

メソッドの詳細

setWriteAcceptCharset

supports

readInternal

getContentLength

writeInternal

getAcceptedCharsets