FlashMap (Spring Framework API)

java.lang.ObjectSE
- java.util.AbstractMapSE<K,V>
- - java.util.HashMapSE<StringSE,ObjectSE>
  - - org.springframework.web.servlet.FlashMap

実装されたすべてのインターフェース:
SerializableSE, CloneableSE, ComparableSE<FlashMap>, MapSE<StringSE, ObjectSE>
```
public final class FlashMap
extends HashMapSE<StringSE,ObjectSE>
implements ComparableSE<FlashMap>
```
FlashMap は、あるリクエストが別のリクエストで使用するための属性を保管する方法を提供します。これは、ある URL から別の URL にリダイレクトするときに最も一般的に必要です。Post/Redirect/Get パターン。FlashMap は、リダイレクトの前（通常はセッション内）に保存され、リダイレクト後に使用可能になり、すぐに削除されます。
FlashMap は、ターゲットパスの識別に役立つリクエストパスとリクエストパラメーターを使用してセットアップできます。この情報がなければ、FlashMap は次のリクエストで利用可能になりますが、これは意図した受信者である場合とそうでない場合があります。リダイレクト時に、ターゲット URL は既知であり、FlashMap はその情報で更新できます。これは、org.springframework.web.servlet.view.RedirectView が使用されるときに自動的に行われます。
メモ: アノテーション付きコントローラーは通常、FlashMap を直接使用しません。アノテーション付きコントローラーでのフラッシュ属性の使用の概要については、org.springframework.web.servlet.mvc.support.RedirectAttributes を参照してください。
導入:
3.1
作成者:
Rossen Stoyanchev
関連事項:
FlashMapManager, 直列化された形式

ネストされたクラスのサマリー
- クラス java.util.AbstractMapSE から継承されたネストクラス / インターフェース
  AbstractMap.SimpleEntrySE<KSE, VSE>, AbstractMap.SimpleImmutableEntrySE<KSE, VSE>
- インターフェース java.util.MapSE から継承されたネストクラス / インターフェース
  Map.EntrySE<KSE, VSE>

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`FlashMap`	`addTargetRequestParam(StringSE name, StringSE value)` この FlashMap のリクエストを識別するリクエストパラメーターを提供します。
`FlashMap`	`addTargetRequestParams(MultiValueMap<StringSE, StringSE> params)` この FlashMap のリクエストを識別するリクエストパラメーターを提供します。
`int`	`compareTo(FlashMap other)` 2 つの FlashMaps を比較し、ターゲット URL パスを指定するか、より多くのターゲット URL パラメーターを持つ方を優先します。
`boolean`	`equals(ObjectSE other)`
`long`	`getExpirationTime()` FlashMap の有効期限を返すか、有効期限が開始していない場合は -1 を返します。
`MultiValueMap<StringSE, StringSE>`	`getTargetRequestParams()` ターゲットリクエストを識別するパラメーター、または空のマップを返します。
`StringSE`	`getTargetRequestPath()` ターゲット URL パス（または何も指定されていない場合は `null`）を返します。
`int`	`hashCode()`
`boolean`	`isExpired()` `startExpirationPeriod(int)` の呼び出しからの経過時間に応じて、このインスタンスが期限切れになっているかどうかを返します。
`void`	`setExpirationTime(long expirationTime)` FlashMap の有効期限を設定します。
`void`	`setTargetRequestPath(StringSE path)` この FlashMap のターゲットリクエストを識別するのに役立つ URL パスを提供します。
`void`	`startExpirationPeriod(int timeToLive)` このインスタンスの有効期限を開始します。
`StringSE`	`toString()`

クラス java.util.HashMapSE から継承されたメソッド
clearSE, cloneSE, computeSE, computeIfAbsentSE, computeIfPresentSE, containsKeySE, containsValueSE, entrySetSE, forEachSE, getSE, getOrDefaultSE, isEmptySE, keySetSE, mergeSE, putSE, putAllSE, putIfAbsentSE, removeSE, removeSE, replaceSE, replaceSE, replaceAllSE, sizeSE, valuesSE

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

- コンストラクターの詳細
  - FlashMap
```
public FlashMap()
```
- メソッドの詳細
  - setTargetRequestPath
```
public void setTargetRequestPath(@Nullable
                                 StringSE path)
```
    この FlashMap のターゲットリクエストを識別するのに役立つ URL パスを提供します。
    パスは絶対パス（例: "/application/resource"）または相対パス（例: "../ resource" ）の場合があります。
  - getTargetRequestPath
```
@Nullable
public StringSE getTargetRequestPath()
```
    ターゲット URL パス（または何も指定されていない場合は null）を返します。
  - addTargetRequestParams
```
public FlashMap addTargetRequestParams(@Nullable
                                       MultiValueMap<StringSE,StringSE> params)
```
    この FlashMap のリクエストを識別するリクエストパラメーターを提供します。
    パラメーター:
    params - 予想されるパラメーターの名前と値を含むマップ
  - addTargetRequestParam
```
public FlashMap addTargetRequestParam(StringSE name,
                                      StringSE value)
```
    この FlashMap のリクエストを識別するリクエストパラメーターを提供します。
    パラメーター:
    name - 期待されるパラメーター名 (空の場合はスキップされます)
    value - 期待値 (空の場合はスキップされます)
  - getTargetRequestParams
```
public MultiValueMap<StringSE,StringSE> getTargetRequestParams()
```
    ターゲットリクエストを識別するパラメーター、または空のマップを返します。
  - startExpirationPeriod
```
public void startExpirationPeriod(int timeToLive)
```
    このインスタンスの有効期限を開始します。
    パラメーター:
    timeToLive - 有効期限までの秒数
  - setExpirationTime
```
public void setExpirationTime(long expirationTime)
```
    FlashMap の有効期限を設定します。これは直列化のために提供されていますが、代わりに startExpirationPeriod(int) を使用することもできます。
    導入:
    4.2
  - getExpirationTime
```
public long getExpirationTime()
```
    FlashMap の有効期限を返すか、有効期限が開始していない場合は -1 を返します。
    導入:
    4.2
  - isExpired
```
public boolean isExpired()
```
    startExpirationPeriod(int) の呼び出しからの経過時間に応じて、このインスタンスが期限切れになっているかどうかを返します。
  - compareTo
```
public int compareTo(FlashMap other)
```
    2 つの FlashMaps を比較し、ターゲット URL パスを指定するか、より多くのターゲット URL パラメーターを持つ方を優先します。FlashMap インスタンスを比較する前に、それらが特定のリクエストに一致することを確認してください。
    次で指定:
    インターフェース ComparableSE<FlashMap> の compareToSE
  - equals
```
public boolean equals(@Nullable
                      ObjectSE other)
```
    次で指定:
    インターフェース MapSE<StringSE, ObjectSE> の equalsSE
    オーバーライド:
    クラス AbstractMapSE<StringSE, ObjectSE> の equalsSE
  - hashCode
```
public int hashCode()
```
    次で指定:
    インターフェース MapSE<StringSE, ObjectSE> の hashCodeSE
    オーバーライド:
    クラス AbstractMapSE<StringSE, ObjectSE> の hashCodeSE
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス AbstractMapSE<StringSE, ObjectSE> の toStringSE

クラス FlashMap

ネストされたクラスのサマリー

クラス java.util.AbstractMapSE から継承されたネストクラス / インターフェース

インターフェース java.util.MapSE から継承されたネストクラス / インターフェース

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

メソッドのサマリー

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

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

コンストラクターの詳細

FlashMap

メソッドの詳細

setTargetRequestPath

getTargetRequestPath

addTargetRequestParams

addTargetRequestParam

getTargetRequestParams

startExpirationPeriod

setExpirationTime

getExpirationTime

isExpired

compareTo

equals

hashCode

toString