クラス ConfigurableNavigationHandler
- java.lang.ObjectSE
-
- jakarta.faces.application.NavigationHandler
-
- jakarta.faces.application.ConfigurableNavigationHandler
- 既知の直属サブクラス
ConfigurableNavigationHandlerWrapper
public abstract class ConfigurableNavigationHandler extends NavigationHandler
ConfigurableNavigationHandler は、
NavigationHandlerの契約を拡張して、ナビゲーションのルールベースを構成するNavigationCaseのランタイムインスペクションを許可します。このクラスが導入された仕様のバージョン(またはそれ以降のバージョン)に準拠する実装では、NavigationHandlerがこのクラスの拡張となるようにする必要があります。- 導入:
- 2.0
コンストラクターの概要
コンストラクター コンストラクター 説明 ConfigurableNavigationHandler()
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract NavigationCasegetNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome)同じ引数でNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)が呼び出された場合にとられるナビゲーションを表すNavigationCaseを返します。そのようなケースがない場合はnullを返します。NavigationCasegetNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome, StringSE toFlowDocumentId)同じ引数でNavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)が呼び出された場合にとられるナビゲーションを表すNavigationCaseを返します。そのようなケースがない場合はnullを返します。abstract MapSE<StringSE,SetSE<NavigationCase>>getNavigationCases()キーが<from-view-id>値であり、値がSet<NavigationCase>であるMap<String, Set<NavigationCase>>を返します。ここで、セット内の各要素は、その<from-view-id>に適用されるNavigationCaseです。voidinspectFlow(FacesContext context, Flow flow)フローシステムによって呼び出され、ナビゲーションルールについてフローをインスペクションします。voidperformNavigation(StringSE outcome)Jakarta Faces 実装にシグナルを送り、提供された結果でナビゲーションを実行するための便利なメソッド。クラス jakarta.faces.application.NavigationHandler から継承されたメソッド
handleNavigation, handleNavigation
メソッドの詳細
getNavigationCase
public abstract NavigationCase getNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome)
同じ引数で
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)が呼び出された場合にとられるナビゲーションを表すNavigationCaseを返します。そのようなケースがない場合はnullを返します。- パラメーター:
context- 現在のリクエストのFacesContextfromAction- 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合はnulloutcome- 以前に呼び出されたアプリケーションアクションによって返された論理結果 (nullかもしれません)- 戻り値:
- ナビゲーションケース、または
null。 - 例外:
NullPointerExceptionSE-contextがnullの場合- 導入:
- 2.0
getNavigationCase
public NavigationCase getNavigationCase(FacesContext context, StringSE fromAction, StringSE outcome, StringSE toFlowDocumentId)
NavigationHandler.handleNavigation(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)が同じ引数で呼び出された場合に実行されるナビゲーションを表すNavigationCaseを返します。そのような場合がない場合は、nullを返します。このメソッドが導入された仕様のバージョンに準拠する実装は、このメソッドをオーバーライドする必要があります。以前のバージョンの仕様に準拠する装飾された実装との互換性のために、toFlowDocumentIdパラメーターを無視してgetNavigationCase(jakarta.faces.context.FacesContext, java.lang.String, java.lang.String)を呼び出すだけの実装が提供されています。- パラメーター:
context- 現在のリクエストのFacesContextfromAction- 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合はnulloutcome- 以前に呼び出されたアプリケーションアクションによって返された論理結果 (nullかもしれません)toFlowDocumentId- ナビゲーションケースのtoFlowDocumentIdプロパティの値 (nullかもしれません)- 戻り値:
- ナビゲーションケース、または
null。 - 例外:
NullPointerExceptionSE-contextがnullの場合- 導入:
- 2.2
getNavigationCases
public abstract MapSE<StringSE,SetSE<NavigationCase>> getNavigationCases()
キーが
<from-view-id>値であり、値がSet<NavigationCase>であるMap<String, Set<NavigationCase>>を返します。ここで、セット内の各要素は、その<from-view-id>に適用されるNavigationCaseです。実装は、このMapへのライブ変更をサポートする必要があります。- 戻り値:
- ナビゲーションケース付きの地図。
- 導入:
- 2.0
performNavigation
public void performNavigation(StringSE outcome)
提供された結果を使用してナビゲーションを実行するように Jakarta Faces 実装に通知する便利なメソッド。NavigationHandler が呼び出されると、現在の viewId は "from viewId" として扱われ、「from アクション」は null になります。
- パラメーター:
outcome- 提供された結果。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
inspectFlow
public void inspectFlow(FacesContext context, Flow flow)
フローシステムによって呼び出され、フローのナビゲーションルールがインスペクションされます。以前の実装との下位互換性のために、空のメソッドが提供されています。
- パラメーター:
context- Faces コンテキスト。flow- 流れ。- 導入:
- 2.2