FormHttpMessageReader (Spring Framework API)

java.lang.ObjectSE
- org.springframework.http.codec.LoggingCodecSupport
- - org.springframework.http.codec.FormHttpMessageReader

実装されたすべてのインターフェース:
HttpMessageReader<MultiValueMap<StringSE, StringSE>>
```
public class FormHttpMessageReader
extends LoggingCodecSupport
implements HttpMessageReader<MultiValueMap<StringSE,StringSE>>
```
HTML フォームデータ、つまりメディア型 "application/x-www-form-urlencoded" のリクエスト本文を読み取るための HttpMessageReader の実装。
導入:
5.0
作成者:
Sebastien Deleuze, Rossen Stoyanchev

フィールドサマリー
フィールド
修飾子と型フィールドと説明
static CharsetSE DEFAULT_CHARSET
リーダーが使用するデフォルトの文字セット。
- クラス org.springframework.http.codec.LoggingCodecSupport から継承されたフィールド
  logger

フィールド
修飾子と型	フィールドと説明
`static CharsetSE`	`DEFAULT_CHARSET` リーダーが使用するデフォルトの文字セット。

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
FormHttpMessageReader()

コンストラクター
コンストラクターと説明
`FormHttpMessageReader()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`canRead(ResolvableType elementType, MediaType mediaType)` 指定されたオブジェクト型がこのリーダーでサポートされているかどうか。
`CharsetSE`	`getDefaultCharset()` 設定されたデフォルトの文字セットを返します。
`int`	`getMaxInMemorySize()` `configured` バイトカウント制限を返します。
`ListSE<MediaType>`	`getReadableMediaTypes()` このリーダーでサポートされているメディア型のリストを返します。
`reactor.core.publisher.Flux<MultiValueMap<StringSE, StringSE>>`	`read(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints)` 入力メッセージから読み取り、オブジェクトのストリームにデコードします。
`reactor.core.publisher.Mono<MultiValueMap<StringSE, StringSE>>`	`readMono(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints)` 入力メッセージから読み取り、単一のオブジェクトにデコードします。
`void`	`setDefaultCharset(CharsetSE charset)` リクエストの Content-Type ヘッダーで明示的に指定されていない場合に、フォームデータの読み取りに使用するデフォルトの文字セットを設定します。
`void`	`setMaxInMemorySize(int byteCount)` 入力フォームデータの最大バイト数を設定します。

クラス org.springframework.http.codec.LoggingCodecSupport から継承されたメソッド
isEnableLoggingRequestDetails, setEnableLoggingRequestDetails

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

インターフェース org.springframework.http.codec.HttpMessageReader から継承されたメソッド
getReadableMediaTypes, read, readMono

- フィールドの詳細
  - DEFAULT_CHARSET
```
public static final CharsetSE DEFAULT_CHARSET
```
    リーダーが使用するデフォルトの文字セット。
- コンストラクターの詳細
  - FormHttpMessageReader
```
public FormHttpMessageReader()
```
- メソッドの詳細
  - setDefaultCharset
```
public void setDefaultCharset(CharsetSE charset)
```
    リクエストの Content-Type ヘッダーで明示的に指定されていない場合に、フォームデータの読み取りに使用するデフォルトの文字セットを設定します。
    デフォルトでは、これは "UTF-8" に設定されています。
  - getDefaultCharset
```
public CharsetSE getDefaultCharset()
```
    設定されたデフォルトの文字セットを返します。
  - setMaxInMemorySize
```
public void setMaxInMemorySize(int byteCount)
```
    入力フォームデータの最大バイト数を設定します。フォームデータは解析される前にバッファリングされるため、バッファリングの量を制限できます。制限を超えると、DataBufferLimitException が発生します。
    デフォルトでは、これは 256K に設定されています。
    パラメーター:
    byteCount - バッファリングする最大バイト数、または無制限の場合は -1
    導入:
    5.1.11
  - getMaxInMemorySize
```
public int getMaxInMemorySize()
```
    configured バイトカウント制限を返します。
    導入:
    5.1.11
  - canRead
```
public boolean canRead(ResolvableType elementType,
                       @Nullable
                       MediaType mediaType)
```
    インターフェースからコピーされた説明: HttpMessageReader
    指定されたオブジェクト型がこのリーダーでサポートされているかどうか。
    次で指定:
    インターフェース HttpMessageReader<MultiValueMap<StringSE, StringSE>> の canRead
    パラメーター:
    elementType - チェックするオブジェクトの型
    mediaType - 読み取り用のメディア型 (おそらく null)
    戻り値:
    読み取り可能な場合は true、そうでない場合は false
  - read
```
public reactor.core.publisher.Flux<MultiValueMap<StringSE,StringSE>> read(ResolvableType elementType,
                                                                      ReactiveHttpInputMessage message,
                                                                      MapSE<StringSE,ObjectSE> hints)
```
    インターフェースからコピーされた説明: HttpMessageReader
    入力メッセージから読み取り、オブジェクトのストリームにデコードします。
    次で指定:
    インターフェース HttpMessageReader<MultiValueMap<StringSE, StringSE>> の read
    パラメーター:
    elementType - HttpMessageReader.canRead(ResolvableType, MediaType) を介して事前にチェックされている必要があるストリーム内のオブジェクトの型
    message - 読み取るメッセージ
    hints - 入力の読み取りおよびデコード方法に関する追加情報
    戻り値:
    要素のデコードされたストリーム
  - readMono
```
public reactor.core.publisher.Mono<MultiValueMap<StringSE,StringSE>> readMono(ResolvableType elementType,
                                                                          ReactiveHttpInputMessage message,
                                                                          MapSE<StringSE,ObjectSE> hints)
```
    インターフェースからコピーされた説明: HttpMessageReader
    入力メッセージから読み取り、単一のオブジェクトにデコードします。
    次で指定:
    インターフェース HttpMessageReader<MultiValueMap<StringSE, StringSE>> の readMono
    パラメーター:
    elementType - HttpMessageReader.canRead(ResolvableType, MediaType) を介して事前にチェックされている必要があるストリーム内のオブジェクトの型
    message - 読み取るメッセージ
    hints - 入力の読み取りおよびデコード方法に関する追加情報
    戻り値:
    デコードされたオブジェクト
  - getReadableMediaTypes
```
public ListSE<MediaType> getReadableMediaTypes()
```
    インターフェースからコピーされた説明: HttpMessageReader
    このリーダーでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null) を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageReader.getReadableMediaTypes(ResolvableType) を使用してより正確なリストを作成します。
    次で指定:
    インターフェース HttpMessageReader<MultiValueMap<StringSE, StringSE>> の getReadableMediaTypes
    戻り値:
    サポートされているメディア型の一般的なリスト

クラス FormHttpMessageReader

フィールドサマリー

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

コンストラクターのサマリー

メソッドのサマリー

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

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

インターフェース org.springframework.http.codec.HttpMessageReader から継承されたメソッド

フィールドの詳細

DEFAULT_CHARSET

コンストラクターの詳細

FormHttpMessageReader

メソッドの詳細

setDefaultCharset

getDefaultCharset

setMaxInMemorySize

getMaxInMemorySize

canRead

read

readMono

getReadableMediaTypes