パッケージ jakarta.faces.application

クラス 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

      public ConfigurableNavigationHandler()

  • メソッドの詳細

    • 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 - 現在のリクエストの FacesContext
      fromAction - 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合は null 
      outcome - 以前に呼び出されたアプリケーションアクションによって返された論理結果 (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 - 現在のリクエストの FacesContext
      fromAction - 指定された結果を取得するために評価されたアクションバインディング式、または結果が他の手段で取得された場合は null 
      outcome - 以前に呼び出されたアプリケーションアクションによって返された論理結果 (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