パッケージ jakarta.faces.lifecycle

クラス LifecycleWrapper

java.lang.ObjectSE
jakarta.faces.lifecycle.Lifecycle
jakarta.faces.lifecycle.LifecycleWrapper
実装されているすべてのインターフェース:
FacesWrapper<Lifecycle>
public abstract class LifecycleWrapper extends Lifecycle implements FacesWrapper<Lifecycle>

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

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

導入:
2.2

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    LifecycleWrapper()
    使用すべきではありません。
    ラップされている実装を使用する他のコンストラクターを使用します。
    LifecycleWrapper(Lifecycle wrapped)
    このライフサイクルが装飾されている場合、装飾を行う実装は、ラップされている実装をこのコンストラクターにプッシュする必要があります。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    addPhaseListener(PhaseListener listener)
    リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心のある新しい PhaseListener インスタンスを登録します。
    void
    attachWindow(FacesContext context)
    ライフサイクル全体でこの実行の UIViewRoot を表示するために使用する ClientWindow を作成または復元します。
    void
    execute(FacesContext context)
    Jakarta Faces Specification Document のセクション 2「リクエスト処理ライフサイクル」に従って、Render Response フェーズまでのリクエスト処理ライフサイクルのすべてのフェーズを指定された順序で実行します。
    PhaseListener[]
    getPhaseListeners()
    この Lifecycle インスタンスに登録されている PhaseListener のセットを返します。
    Lifecycle
    getWrapped()
    このインターフェースを実装するクラスは、このメソッドを使用して、ラップされているクラスのインスタンスを返します。
    void
    removePhaseListener(PhaseListener listener)
    リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知される必要がなくなった既存の PhaseListener インスタンスを登録解除します。
    void
    render(FacesContext context)
    現在のリクエストに関連付けられている FacesContext インスタンスで responseComplete() メソッドが呼び出されていない限り、リクエスト処理ライフサイクルのレスポンスのレンダリングフェーズを実行します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • コンストラクターの詳細

    • LifecycleWrapper

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

    • LifecycleWrapper

      public LifecycleWrapper(Lifecycle wrapped)

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

      パラメーター:
      wrapped - ラップされる実装。
      導入:
      2.3

  • メソッドの詳細

    • getWrapped

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

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

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

    • addPhaseListener

      public void addPhaseListener(PhaseListener listener)
      クラスからコピーされた説明: Lifecycle

      リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心のある新しい PhaseListener インスタンスを登録します。

      次で指定:
      クラス Lifecycle の addPhaseListener 
      パラメーター:
      listener - 登録する PhaseListener

    • execute

      public void execute(FacesContext context) throws FacesException
      クラスからコピーされた説明: Lifecycle

      Jakarta Faces Specification Document のセクション 2「リクエスト処理ライフサイクル」に従って、Render Response フェーズまでのリクエスト処理ライフサイクルのすべてのフェーズを指定された順序で実行します。処理フローは、現在のリクエストに関連付けられた FacesContext インスタンスの renderResponse() または responseComplete() メソッドの呼び出しによって (アプリケーション、コンポーネント、イベントリスナーによって) 影響を受ける可能性があります。

      次で指定:
      クラス Lifecycle の execute 
      パラメーター:
      context - 処理するリクエストの FacesContext
      例外:
      FacesException - リクエスト処理ライフサイクルの実行中にスローされた場合

    • getPhaseListeners

      public PhaseListener[] getPhaseListeners()
      クラスからコピーされた説明: Lifecycle

      この Lifecycle インスタンスに登録されている PhaseListener のセットを返します。登録済みのリスナーがない場合は、長さ 0 の配列が返されます。

      次で指定:
      クラス Lifecycle の getPhaseListeners 
      戻り値:
      登録された PhaseListener のセット

    • removePhaseListener

      public void removePhaseListener(PhaseListener listener)
      クラスからコピーされた説明: Lifecycle

      リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心がなくなった既存の PhaseListener インスタンスの登録を解除します。そのようなリスナーインスタンスが登録されていない場合、アクションは実行されません。

      次で指定:
      クラス Lifecycle の removePhaseListener 
      パラメーター:
      listener - 登録解除する PhaseListener

    • render

      public void render(FacesContext context) throws FacesException
      クラスからコピーされた説明: Lifecycle

      現在のリクエストに関連付けられている FacesContext インスタンスで responseComplete() メソッドが呼び出されていない限り、リクエスト処理ライフサイクルのレスポンスのレンダリングフェーズを実行します。

      次で指定:
      クラス Lifecycle の render 
      パラメーター:
      context - 処理中のリクエストの FacesContext
      例外:
      FacesException - リクエスト処理ライフサイクルの実行中に例外がスローされた場合

    • attachWindow

      public void attachWindow(FacesContext context)
      クラスからコピーされた説明: Lifecycle

      ライフサイクル全体でこの実行の UIViewRoot を表示するために使用する ClientWindow を作成または復元します。機能の概要については、ClientWindow のクラスドキュメントを参照してください。ExternalContext.getClientWindow() が null を返す場合は、ClientWindowFactory を使用して ClientWindow の新しいインスタンスを作成します。結果が null でない場合は、ClientWindow.decode(jakarta.faces.context.FacesContext) を呼び出します。ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow) を呼び出して、新しい ClientWindow を保存します。

      オーバーライド:
      クラス Lifecycle の attachWindow 
      パラメーター:
      context - このリクエストの FacesContext