パッケージ org.springframework.web.servlet

クラス FlashMap

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
関連事項:

  • コンストラクターの詳細

    • 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> の hashCode 
      オーバーライド:
      クラス AbstractMapSE<StringSE,ObjectSE> の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス AbstractMapSE<StringSE,ObjectSE> の toString