パッケージ org.springframework.webflow.engine.model.builder

インターフェース FlowModelBuilder

すべての既知の実装クラス:
XmlFlowModelBuilder
public interface FlowModelBuilder
フローモデルを構築するために使用されるビルダーインターフェース。フローモデルを構築するプロセスは、次の手順で構成されます。
  1. init() を呼び出してこのビルダーを初期化します。
  2. フローモデルを作成するには、build() を呼び出します。
  3. 完全に構築された FlowModel モデルを返すには、getFlowModel() を呼び出します。
  4. このビルダーを破棄し、dispose() を呼び出してビルドプロセス中に割り当てられたリソースを解放します。

実装では、特定の種類のフロー (たとえば、XmlFlowModelBuilder) 用、または XML 定義からフローを構築するためのフロー構築ロジックをカプセル化する必要があります。

これは、典型的な GoF ビルダーパターンの良い例です。

作成者:
Keith Donald, Erwin Vervaet, Scott Andrews
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    build()
    フローの開始時にフローによって初期化される変数を構築します。
    void
    dispose()
    ビルダーをシャットダウンし、保持しているリソースを解放します。
    FlowModel
    getFlowModel()
    完全に構築されたフローモデルを取得します。
    org.springframework.core.io.Resource
    getFlowModelResource()
    このフローモデルを構築するためにアクセスされる、基礎となるフローモデルリソースを取得します。
    boolean
    hasFlowModelResourceChanged()
    init() への最後の呼び出し以降に基礎となるフローモデルリソースが変更された場合は true を返します。
    void
    init()
    このビルダーを初期化します。

  • メソッドの詳細

    • init

      void init() throws FlowModelBuilderException
      このビルダーを初期化します。これにより、ビルダーは、たとえばフロー定義を表す外部化されたリソースへのストリームを開くことができます。
      例外:
      FlowModelBuilderException - フローの構築中に例外が発生しました

    • build

      void build() throws FlowModelBuilderException
      フローの開始時にフローによって初期化される変数を構築します。
      例外:
      FlowModelBuilderException - フローの構築中に例外が発生しました

    • getFlowModel

      FlowModel getFlowModel() throws FlowModelBuilderException
      完全に構築されたフローモデルを取得します。アセンブリ後にビルダーのアセンブラー (ディレクター) によって呼び出されます。このメソッドがアセンブラーによって呼び出される場合、フロー構築が完了し、返されたフローモデルが使用できる状態になっていることが予想されます。
      例外:
      FlowModelBuilderException - このフローの構築中に例外が発生しました

    • dispose

      void dispose() throws FlowModelBuilderException
      ビルダーをシャットダウンし、保持しているリソースを解放します。新しいフロー構築プロセスは、init() メソッドの別の呼び出しから開始する必要があります。
      例外:
      FlowModelBuilderException - このフローを破棄中に例外が発生しました

    • getFlowModelResource

      org.springframework.core.io.Resource getFlowModelResource()
      このフローモデルを構築するためにアクセスされた、基礎となるフローモデルリソースを取得します。このビルダーがリソースからフローモデルを構築しない場合は null を返します。
      戻り値:
      フローモデルリソース

    • hasFlowModelResourceChanged

      boolean hasFlowModelResourceChanged()
      init() への最後の呼び出し以降に基礎となるフローモデルリソースが変更された場合は true を返します。フローモデルがリソースから構築されていない場合は常に false を返します。
      戻り値:
      フローモデルを支えるリソースが変更された場合は true