パッケージ jakarta.faces.application

クラス NavigationCaseWrapper

java.lang.ObjectSE
jakarta.faces.application.NavigationCase
jakarta.faces.application.NavigationCaseWrapper
実装済みのインターフェース一覧:
FacesWrapper<NavigationCase>

public abstract class NavigationCaseWrapper extends NavigationCase implements FacesWrapper<NavigationCase>

既存の NavigationCase インスタンスに特殊な動作を提供したい開発者によってサブクラス化することができる NavigationCase の簡単な実装を提供します。すべてのメソッドのデフォルト実装は、ラップされた NavigationCase インスタンスを呼び出すことです。

使用方法: このクラスを継承し、ラップされている実装をコンストラクターにプッシュし、getWrapped() を使用してラップされているインスタンスにアクセスします。

導入:
2.2
  • コンストラクターの詳細

    • NavigationCaseWrapper

      @DeprecatedSE public NavigationCaseWrapper()
      使用すべきではありません。
      ラップされている実装を使用する他のコンストラクターを使用します。
    • NavigationCaseWrapper

      public NavigationCaseWrapper(NavigationCase wrapped)

      このナビゲーションケースが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。getWrapped() は、ラップされている実装を返します。

      パラメーター:
      wrapped - ラップされる実装。
      導入:
      2.3
  • 方法の詳細

    • getWrapped

      public NavigationCase getWrapped()
      インターフェースからコピーされた説明: FacesWrapper

      このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。

      次で指定:
      インターフェース FacesWrapper<NavigationCase> 内の getWrapped 
      戻り値:
      ラップされたインスタンス。
    • equals

      public boolean equals(ObjectSE o)
      オーバーライド:
      クラス NavigationCaseequals 
    • hashCode

      public int hashCode()
      オーバーライド:
      クラス NavigationCasehashCode 
    • toString

      public StringSE toString()
      オーバーライド:
      クラス NavigationCasetoString 
    • getActionURL

      public URLSE getActionURL(FacesContext context) throws MalformedURLExceptionSE
      クラスからコピーされた説明: NavigationCase

      URL のパス部分に ViewHandler.getActionURL(jakarta.faces.context.FacesContext, java.lang.String) を使用して、この NavigationCase インスタンスへの絶対 URL を構築します。

      オーバーライド:
      クラス NavigationCasegetActionURL 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      アクション URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。
    • getBookmarkableURL

      public URLSE getBookmarkableURL(FacesContext context) throws MalformedURLExceptionSE
      クラスからコピーされた説明: NavigationCase

      URL のパス部分に ViewHandler.getBookmarkableURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean) を使用して、この NavigationCase インスタンスへのブックマーク可能なリンクに適した絶対 URL を構築します。この URL には、ビュー内のメタデータとして指定されたビューパラメーターを含めることができます。

      オーバーライド:
      クラス NavigationCasegetBookmarkableURL 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      ブックマーク可能な URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。
    • getCondition

      public BooleanSE getCondition(FacesContext context)
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <if> を評価します(ある場合)。評価される式は、文字列としてコンストラクターに渡されます。式が評価されるとき、その値は通常の Jakarta Expression Language 強制ルールに従って boolean に強制変換される必要があります。

      Note は、式の評価またはその値の取得プロセス中に発生した例外をスローします。
      オーバーライド:
      クラス NavigationCasegetCondition 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      この <navigation-case> に関連付けられている <if> 要素がない場合は null、それ以外の場合は条件の評価結果を返します
    • getFromAction

      public StringSE getFromAction()
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <from-action> を返します

      オーバーライド:
      クラス NavigationCasegetFromAction 
      戻り値:
      from アクション。
    • getFromOutcome

      public StringSE getFromOutcome()
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <from-outcome> を返します

      オーバーライド:
      クラス NavigationCasegetFromOutcome 
      戻り値:
      からの結果。
    • getFromViewId

      public StringSE getFromViewId()
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> がネストされている <navigation-rule> の <from-view-id> を返します。

      オーバーライド:
      クラス NavigationCasegetFromViewId 
      戻り値:
      viedId から。
    • getParameters

      public MapSE<StringSE,ListSE<StringSE>> getParameters()
      クラスからコピーされた説明: NavigationCase

      リダイレクトが必要なナビゲーションケースに含めるパラメーターを返します。パラメーターが定義されていない場合、null が返されます。Map のキーはパラメーター名です。各キーの対応する値は、変換されていない値の List です。

      オーバーライド:
      クラス NavigationCasegetParameters 
      戻り値:
      パラメーターのリスト、または null
    • getRedirectURL

      public URLSE getRedirectURL(FacesContext context) throws MalformedURLExceptionSE
      クラスからコピーされた説明: NavigationCase

      URL のパス部分で ViewHandler.getRedirectURL(jakarta.faces.context.FacesContext, java.lang.String, java.util.Map<java.lang.String, java.util.List<java.lang.String>>, boolean) を使用して、この NavigationCase インスタンスへの「リダイレクト」に適した絶対 URL を構築します。

      オーバーライド:
      クラス NavigationCasegetRedirectURL 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      リダイレクト URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。
    • getResourceURL

      public URLSE getResourceURL(FacesContext context) throws MalformedURLExceptionSE
      クラスからコピーされた説明: NavigationCase

      URL のパス部分に ViewHandler.getResourceURL(jakarta.faces.context.FacesContext, java.lang.String) を使用して、この NavigationCase インスタンスへの絶対 URL を構築します。

      オーバーライド:
      クラス NavigationCasegetResourceURL 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      リソース URL。
      例外:
      MalformedURLExceptionSE - URL を構築するプロセスが原因でこの例外がスローされる場合。
    • getToViewId

      public StringSE getToViewId(FacesContext context)
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <to-view-id> を評価します

      オーバーライド:
      クラス NavigationCasegetToViewId 
      パラメーター:
      context - 現在のリクエストの FacesContext
      戻り値:
      ナビゲートするビュー ID
    • getToFlowDocumentId

      public StringSE getToFlowDocumentId()
      クラスからコピーされた説明: NavigationCase

      このナビゲーションケースがフロー呼び出しを表す場合、このプロパティは、NavigationCase.getFromOutcome() からの戻り値によって ID が指定されたフローが定義されている documentId です。実装では、このメソッドをオーバーライドして、対応するアプリケーション構成リソース要素で定義された値を返す必要があります。基本実装では、空の文字列が返されます。

      オーバーライド:
      クラス NavigationCasegetToFlowDocumentId 
      戻り値:
      toFlow ドキュメント ID。
    • hasCondition

      public boolean hasCondition()
      クラスからコピーされた説明: NavigationCase

      このナビゲーションケースに関連付けられた <if> 要素があるかどうかをテストします。

      オーバーライド:
      クラス NavigationCasehasCondition 
      戻り値:
      この <navigation-case> に関連付けられている <if> 要素がある場合は true、それ以外の場合は false
    • isIncludeViewParams

      public boolean isIncludeViewParams()
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <redirect> 値を返します。ビューのパラメーターをリダイレクト URL にエンコードする必要がある場合、これは true になります。(リダイレクトの場合にのみ適用されます)

      オーバーライド:
      クラス NavigationCaseisIncludeViewParams 
      戻り値:
      ビューパラメーターを含める場合は true、それ以外の場合は false
    • isRedirect

      public boolean isRedirect()
      クラスからコピーされた説明: NavigationCase

      この <navigation-case> の <redirect> 値を返します。新しいビューに ExternalContext.redirect(String) を介してナビゲートする必要がある場合、これは true になります。

      オーバーライド:
      クラス NavigationCaseisRedirect 
      戻り値:
      これがリダイレクトの場合は true、それ以外の場合は false