クラス ModelAndView

java.lang.ObjectSE
org.springframework.web.servlet.ModelAndView

public class ModelAndView extends ObjectSE
Web MVC フレームワークのモデルとビューの両方のホルダー。これらはまったく異なることに注意してください。このクラスは、コントローラーが単一の戻り値でモデルとビューの両方を返すことを可能にするために、両方を保持するだけです。

DispatcherServlet によって解決される、ハンドラーによって返されるモデルとビューを表します。ビューは、ViewResolver オブジェクトによって解決される必要があるストリングビュー名の形式を取ることができます。または、View オブジェクトを直接指定できます。モデルはマップであり、名前をキーとする複数のオブジェクトを使用できます。

作成者:
Rod Johnson, Juergen Hoeller, Rob Harrop, Rossen Stoyanchev
関連事項:
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    Bean スタイルの使用のデフォルトコンストラクター: コンストラクター引数を渡すのではなく、Bean プロパティを設定します。
    公開するモデルデータがない場合に便利なコンストラクター。
    ModelAndView(StringSE viewName, StringSE modelName, ObjectSE modelObject)
    単一のモデルオブジェクトを取得する便利なコンストラクター。
    ModelAndView(StringSE viewName, MapSE<StringSE,?> model)
    ビュー名とモデルを指定して、新しい ModelAndView を作成します。
    ModelAndView(StringSE viewName, MapSE<StringSE,?> model, HttpStatusCode status)
    ビュー名、モデル、HTTP ステータスを指定して、新しい ModelAndView を作成します。
    ビュー名と HTTP ステータスを指定して、新しい ModelAndView を作成します。
    公開するモデルデータがない場合に便利なコンストラクター。
    ModelAndView(View view, StringSE modelName, ObjectSE modelObject)
    単一のモデルオブジェクトを取得する便利なコンストラクター。
    View オブジェクトとモデルを指定して、新しい ModelAndView を作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    提供されたマップに含まれるすべての属性をモデルに追加します。
    addObject(ObjectSE attributeValue)
    パラメーター名の生成を使用して、モデルに属性を追加します。
    addObject(StringSE attributeName, ObjectSE attributeValue)
    モデルに属性を追加します。
    void
    この ModelAndView オブジェクトの状態をクリアします。
    モデルマップを返します。
    モデルマップを返します。
    基になる ModelMap インスタンスを返します(非 null)。
    レスポンスに構成された HTTP ステータスがあれば、それを返します。
    View オブジェクト、または ViewResolver を介して DispatcherServlet によって解決されるビュー名を使用している場合は null を返します。
    DispatcherServlet によって ViewResolver を介して解決されるビュー名、または View オブジェクトを使用している場合は null を返します。
    boolean
    この ModelAndView にビューがあるかどうかを、ビュー名として、または直接 View インスタンスとして示します。
    boolean
    この ModelAndView オブジェクトが空かどうか、つまり
    boolean
    ビュー参照を使用するかどうか、つまり
    void
    レスポンスに使用する HTTP ステータスを設定します。
    void
    この ModelAndView の View オブジェクトを設定します。
    void
    ViewResolver を介して DispatcherServlet によって解決されるこの ModelAndView のビュー名を設定します。
    このモデルとビューに関する診断情報を返します。
    boolean
    clear() の呼び出しの結果、この ModelAndView オブジェクトが空かどうかを返します。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
  • コンストラクターの詳細

    • ModelAndView

      public ModelAndView()
      Bean スタイルの使用のデフォルトコンストラクター: コンストラクター引数を渡すのではなく、Bean プロパティを設定します。
      関連事項:
    • ModelAndView

      public ModelAndView(StringSE viewName)
      公開するモデルデータがない場合に便利なコンストラクター。addObject と組み合わせて使用することもできます。
      パラメーター:
      viewName - DispatcherServlet の ViewResolver によって解決される、レンダリングするビューの名前
      関連事項:
    • ModelAndView

      public ModelAndView(View view)
      公開するモデルデータがない場合に便利なコンストラクター。addObject と組み合わせて使用することもできます。
      パラメーター:
      view - レンダリングする View オブジェクト
      関連事項:
    • ModelAndView

      public ModelAndView(StringSE viewName, @Nullable MapSE<StringSE,?> model)
      ビュー名とモデルを指定して、新しい ModelAndView を作成します。
      パラメーター:
      viewName - DispatcherServlet の ViewResolver によって解決される、レンダリングするビューの名前
      model - モデル名(文字列)からモデルオブジェクト(オブジェクト)へのマップ。モデルエントリは null ではない場合がありますが、モデルデータがない場合、モデルマップは null である場合があります。
    • ModelAndView

      public ModelAndView(View view, @Nullable MapSE<StringSE,?> model)
      View オブジェクトとモデルを指定して、新しい ModelAndView を作成します。注: 提供されたモデルデータは、このクラスの内部ストレージにコピーされます。このクラスに提供した後、提供されたマップを変更することを考慮すべきではありません
      パラメーター:
      view - レンダリングする View オブジェクト
      model - モデル名(文字列)からモデルオブジェクト(オブジェクト)へのマップ。モデルエントリは null ではない場合がありますが、モデルデータがない場合、モデルマップは null である場合があります。
    • ModelAndView

      public ModelAndView(StringSE viewName, HttpStatusCode status)
      ビュー名と HTTP ステータスを指定して、新しい ModelAndView を作成します。
      パラメーター:
      viewName - DispatcherServlet の ViewResolver によって解決される、レンダリングするビューの名前
      status - レスポンスに使用する HTTP ステータスコード (ビューのレンダリングの直前に設定する)
      導入:
      4.3.8
    • ModelAndView

      public ModelAndView(@Nullable StringSE viewName, @Nullable MapSE<StringSE,?> model, @Nullable HttpStatusCode status)
      ビュー名、モデル、HTTP ステータスを指定して、新しい ModelAndView を作成します。
      パラメーター:
      viewName - DispatcherServlet の ViewResolver によって解決される、レンダリングするビューの名前
      model - モデル名(文字列)からモデルオブジェクト(オブジェクト)へのマップ。モデルエントリは null ではない場合がありますが、モデルデータがない場合、モデルマップは null である場合があります。
      status - レスポンスに使用する HTTP ステータスコード (ビューのレンダリングの直前に設定する)
      導入:
      4.3
    • ModelAndView

      public ModelAndView(StringSE viewName, StringSE modelName, ObjectSE modelObject)
      単一のモデルオブジェクトを取得する便利なコンストラクター。
      パラメーター:
      viewName - DispatcherServlet の ViewResolver によって解決される、レンダリングするビューの名前
      modelName - モデル内の単一エントリの名前
      modelObject - 単一のモデルオブジェクト
    • ModelAndView

      public ModelAndView(View view, StringSE modelName, ObjectSE modelObject)
      単一のモデルオブジェクトを取得する便利なコンストラクター。
      パラメーター:
      view - レンダリングする View オブジェクト
      modelName - モデル内の単一エントリの名前
      modelObject - 単一のモデルオブジェクト
  • メソッドの詳細

    • setViewName

      public void setViewName(@Nullable StringSE viewName)
      ViewResolver を介して DispatcherServlet によって解決されるこの ModelAndView のビュー名を設定します。既存のビュー名またはビューをオーバーライドします。
    • getViewName

      @Nullable public StringSE getViewName()
      DispatcherServlet によって ViewResolver を介して解決されるビュー名、または View オブジェクトを使用している場合は null を返します。
    • setView

      public void setView(@Nullable View view)
      この ModelAndView の View オブジェクトを設定します。既存のビュー名またはビューをオーバーライドします。
    • getView

      @Nullable public View getView()
      View オブジェクト、または ViewResolver を介して DispatcherServlet によって解決されるビュー名を使用している場合は null を返します。
    • hasView

      public boolean hasView()
      この ModelAndView にビューがあるかどうかを、ビュー名として、または直接 View インスタンスとして示します。
    • isReference

      public boolean isReference()
      ビュー参照を使用するかどうか、つまり、ビューが ViewResolver を介して DispatcherServlet によって解決される名前を介して指定されている場合、true を使用するかどうかを返します。
    • getModelInternal

      @Nullable protected MapSE<StringSE,ObjectSE> getModelInternal()
      モデルマップを返します。null を返す場合があります。モデルの評価のために DispatcherServlet によって呼び出されます。
    • getModelMap

      public ModelMap getModelMap()
      基になる ModelMap インスタンスを返します(非 null)。
    • getModel

      public MapSE<StringSE,ObjectSE> getModel()
      モデルマップを返します。null を返しません。モデルを変更するためにアプリケーションコードによって呼び出されます。
    • setStatus

      public void setStatus(@Nullable HttpStatusCode status)
      レスポンスに使用する HTTP ステータスを設定します。

      レスポンスステータスは、ビューのレンダリングの直前に設定されます。

      導入:
      4.3
    • getStatus

      @Nullable public HttpStatusCode getStatus()
      レスポンスに構成された HTTP ステータスがあれば、それを返します。
      導入:
      4.3
    • addObject

      public ModelAndView addObject(StringSE attributeName, @Nullable ObjectSE attributeValue)
      モデルに属性を追加します。
      パラメーター:
      attributeName - モデルに追加するオブジェクトの名前 (非 null)
      attributeValue - モデルに追加するオブジェクト (null にすることができます)
      関連事項:
    • addObject

      public ModelAndView addObject(ObjectSE attributeValue)
      パラメーター名の生成を使用して、モデルに属性を追加します。
      パラメーター:
      attributeValue - モデルに追加するオブジェクト (非 null)
      関連事項:
    • addAllObjects

      public ModelAndView addAllObjects(@Nullable MapSE<StringSE,?> modelMap)
      提供されたマップに含まれるすべての属性をモデルに追加します。
      パラメーター:
      modelMap - attributeName → attributeValue ペアのマップ
      関連事項:
    • clear

      public void clear()
      この ModelAndView オブジェクトの状態をクリアします。オブジェクトはその後空になります。

      HandlerInterceptor の postHandle メソッドで特定の ModelAndView オブジェクトのレンダリングを抑制するために使用できます。

      関連事項:
    • isEmpty

      public boolean isEmpty()
      この ModelAndView オブジェクトが空かどうか、つまり、ビューを保持せず、モデルを含まないかどうかを返します。
    • wasCleared

      public boolean wasCleared()
      clear() の呼び出しの結果、この ModelAndView オブジェクトが空かどうか、つまり、ビューを保持せず、モデルを含まないかどうかを返します。

      clear() の呼び出しにインスタンスに追加の状態が追加された場合、 false を返します。

      関連事項:
    • toString

      public StringSE toString()
      このモデルとビューに関する診断情報を返します。
      オーバーライド:
      クラス ObjectSEtoString