クラス Flow
- java.lang.ObjectSE
-
- jakarta.faces.flow.Flow
public abstract class Flow extends ObjectSE
Flow は、FacesFlow の実行時表現です。ランタイムによってサービスが開始されると、このクラスのインスタンスは不変になります。インスタンスはアプリケーション内のフローのすべての使用箇所で共有されるため、実装はスレッドセーフである必要があります。
- 導入:
- 2.2
コンストラクターのサマリー
コンストラクター コンストラクター 説明 Flow()
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 abstract StringSE
getClientWindowFlowId(ClientWindow curWindow)
ClientWindow
の ID を取得し、"_" とgetId()
からの戻り値を追加します。abstract StringSE
getDefiningDocumentId()
引数フローが定義されているドキュメントの不変のアプリケーション固有識別子を返します。abstract MethodExpression
getFinalizer()
このフローを終了する前に発生する最後のこととして、ランタイムによって呼び出される必要があるMethodExpression
を返します。abstract FlowCallNode
getFlowCall(Flow targetFlow)
abstract MapSE<StringSE,FlowCallNode>
getFlowCalls()
このフローに対して宣言されたすべてのフロー呼び出しノードを含む不変のデータ構造を返します。abstract StringSE
getId()
このフローの不変 ID を返します。abstract MapSE<StringSE,Parameter>
getInboundParameters()
このフローに対して宣言された受信パラメーターを含む不変のデータ構造を返します。abstract MethodExpression
getInitializer()
このフローに対して宣言されたFlowScoped
Bean をアクティブ化した直後にランタイムによって呼び出される必要があるMethodExpression
を返します。abstract ListSE<MethodCallNode>
getMethodCalls()
このフローに対して宣言されたすべてのメソッド呼び出しノードを含む不変のデータ構造を返します。abstract MapSE<StringSE,SetSE<NavigationCase>>
getNavigationCases()
このフロー内のナビゲーションケースの変更不可能なビューを返します。abstract FlowNode
getNode(StringSE nodeId)
ID でジェネリクスFlowNode
を返します。見つからない場合はnull
を返します。abstract MapSE<StringSE,ReturnNode>
getReturns()
このフローに対して宣言されたすべての戻りノードを含む不変のデータ構造を返します。abstract StringSE
getStartNodeId()
このフローに入るときにアクティブ化されるデフォルトノードの不変 ID を返します。abstract MapSE<StringSE,SwitchNode>
getSwitches()
このフローに対して宣言されたすべてのスイッチノードを含む不変のデータ構造を返します。abstract ListSE<ViewNode>
getViews()
このフローに対して宣言されたすべてのビューノードを含む不変のデータ構造を返します。
メソッドの詳細
getId
public abstract StringSE getId()
このフローの不変 ID を返します。これは、定義ドキュメント(アプリケーション構成リソースファイルなど)内で一意である必要がありますが、アプリケーション全体で一意である必要はありません。
- 戻り値:
- ID。
- 導入:
- 2.2
getDefiningDocumentId
public abstract StringSE getDefiningDocumentId()
引数フローが定義されているドキュメントの不変のアプリケーション固有識別子を返します。
- 戻り値:
- 定義するドキュメント ID
- 導入:
- 2.2
getStartNodeId
public abstract StringSE getStartNodeId()
このフローに入るときにアクティブ化されるデフォルトノードの不変 ID を返します。
- 戻り値:
- 開始ノードの ID
- 導入:
- 2.2
getFinalizer
public abstract MethodExpression getFinalizer()
このフローを終了する前に発生する最後のこととして、ランタイムによって呼び出される必要がある
MethodExpression
を返します。このフローに対して宣言されたFlowScoped
Bean は、このMethodExpression
によって参照されるメソッドから制御が戻るまで、スコープ内に留まる必要があります。- 戻り値:
- ファイナライザの
MethodExpresion
。 - 導入:
- 2.2
getInitializer
public abstract MethodExpression getInitializer()
このフローに対して宣言された
FlowScoped
Bean をアクティブ化した直後にランタイムによって呼び出される必要があるMethodExpression
を返します。- 戻り値:
- イニシャライザーの
MethodExpresion
。 - 導入:
- 2.2
getInboundParameters
public abstract MapSE<StringSE,Parameter> getInboundParameters()
このフローに対して宣言された受信パラメーターを含む不変のデータ構造を返します。これらのパラメーターの使用方法の仕様については、
FlowHandler.transition(jakarta.faces.context.FacesContext, jakarta.faces.flow.Flow, jakarta.faces.flow.Flow, jakarta.faces.flow.FlowCallNode, java.lang.String)
を参照してください。受信パラメーターは特定のフローインスタンスに関連付けられていますが、送信パラメーターは新しいフローへの移行を引き起こすFlowCallNode
に関連付けられています。- 戻り値:
- 受信パラメーター
- 導入:
- 2.2
getViews
public abstract ListSE<ViewNode> getViews()
このフローに対して宣言されたすべてのビューノードを含む不変のデータ構造を返します。
- 戻り値:
- このフローのビューノード
- 導入:
- 2.2
getReturns
public abstract MapSE<StringSE,ReturnNode> getReturns()
このフローに対して宣言されたすべての戻りノードを含む不変のデータ構造を返します。
- 戻り値:
- このフローのリターンノード。
- 導入:
- 2.2
getSwitches
public abstract MapSE<StringSE,SwitchNode> getSwitches()
このフローに対して宣言されたすべてのスイッチノードを含む不変のデータ構造を返します。
- 戻り値:
- このフローのスイッチノード
- 導入:
- 2.2
getFlowCalls
public abstract MapSE<StringSE,FlowCallNode> getFlowCalls()
このフローに対して宣言されたすべてのフロー呼び出しノードを含む不変のデータ構造を返します。
- 戻り値:
- このフローのフロー呼び出しノード
- 導入:
- 2.2
getFlowCall
public abstract FlowCallNode getFlowCall(Flow targetFlow)
このフローからの
targetFlow
の呼び出しを表すFlowCallNode
、またはこのフローからtargetFlow
に到達できない場合はnull
を返します。- パラメーター:
targetFlow
-FlowCallNode
が返されるフロー- 戻り値:
- 引数フローの
FlowCallNode
またはnull
- 導入:
- 2.2
getMethodCalls
public abstract ListSE<MethodCallNode> getMethodCalls()
このフローに対して宣言されたすべてのメソッド呼び出しノードを含む不変のデータ構造を返します。
- 戻り値:
- このフローのメソッド呼び出しノード
- 導入:
- 2.2
getNode
public abstract FlowNode getNode(StringSE nodeId)
ID でジェネリクス
FlowNode
を返します。見つからない場合はnull
を返します。
getNavigationCases
public abstract MapSE<StringSE,SetSE<NavigationCase>> getNavigationCases()
このフロー内のナビゲーションケースの変更不可能なビューを返します。
- 戻り値:
- ナビゲーションケース
getClientWindowFlowId
public abstract StringSE getClientWindowFlowId(ClientWindow curWindow)
ClientWindow
の ID を取得し、"_" とgetId()
からの戻り値を追加します。結果を返します。- パラメーター:
curWindow
-- 戻り値:
- このフローに対して生成されたクライアントウィンドウ ID。
- 導入:
- 2.2