クラス Lifecycle
- java.lang.ObjectSE
-
- jakarta.faces.lifecycle.Lifecycle
- 既知の直属サブクラス
LifecycleWrapper
public abstract class Lifecycle extends ObjectSE
ライフサイクルは、特定の Jakarta Faces リクエストのライフサイクル全体の処理を管理します。各フェーズの実行中に発生したアクティビティによって別段の指示がない限り、Jakarta Faces Specification によって定義されたすべてのフェーズを指定された順序で実行する責任があります。
Lifecycleのインスタンスは、指定されたライフサイクル ID に対してLifecycleFactoryのgetLifecycle()メソッドを呼び出すことによって作成されます。このインスタンスは複数の同時リクエスト間で共有されるため、スレッドセーフな方法で実装する必要があります。
コンストラクターの概要
コンストラクター コンストラクター 説明 Lifecycle()
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract voidaddPhaseListener(PhaseListener listener)リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心のある新しいPhaseListenerインスタンスを登録します。voidattachWindow(FacesContext context)ライフサイクル全体でこの実行のUIViewRootを表示するために使用するClientWindowを作成または復元します。abstract voidexecute(FacesContext context)Jakarta Faces Specification Document のセクション 2「リクエスト処理ライフサイクル」に従って、Render Response フェーズまでのリクエスト処理ライフサイクルのすべてのフェーズを指定された順序で実行します。abstract PhaseListener[]getPhaseListeners()このLifecycleインスタンスに登録されているPhaseListenerのセットを返します。abstract voidremovePhaseListener(PhaseListener listener)リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知される必要がなくなった既存のPhaseListenerインスタンスを登録解除します。abstract voidrender(FacesContext context)現在のリクエストに関連付けられているFacesContextインスタンスでresponseComplete()メソッドが呼び出されていない限り、リクエスト処理ライフサイクルのレスポンスのレンダリングフェーズを実行します。
メソッドの詳細
addPhaseListener
public abstract void addPhaseListener(PhaseListener listener)
リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心のある新しい
PhaseListenerインスタンスを登録します。- パラメーター:
listener- 登録するPhaseListener- 例外:
NullPointerExceptionSE-listenerがnullの場合
execute
public abstract void execute(FacesContext context) throws FacesException
Jakarta Faces Specification Document のセクション 2「リクエスト処理ライフサイクル」に従って、Render Response フェーズまでのリクエスト処理ライフサイクルのすべてのフェーズを指定された順序で実行します。処理フローは、現在のリクエストに関連付けられた
FacesContextインスタンスのrenderResponse()またはresponseComplete()メソッドの呼び出しによって (アプリケーション、コンポーネント、イベントリスナーによって) 影響を受ける可能性があります。- パラメーター:
context- 処理するリクエストの FacesContext- 例外:
FacesException- リクエスト処理ライフサイクルの実行中にスローされた場合NullPointerExceptionSE-contextがnullの場合
attachWindow
public void attachWindow(FacesContext context)
ライフサイクル全体でこの実行の
UIViewRootを表示するために使用するClientWindowを作成または復元します。機能の概要については、ClientWindowのクラスドキュメントを参照してください。ExternalContext.getClientWindow()が null を返す場合は、ClientWindowFactoryを使用してClientWindowの新しいインスタンスを作成します。結果が null でない場合は、ClientWindow.decode(jakarta.faces.context.FacesContext)を呼び出します。ExternalContext.setClientWindow(jakarta.faces.lifecycle.ClientWindow)を呼び出して、新しいClientWindowを保存します。- パラメーター:
context- このリクエストのFacesContext- 導入:
- 2.2
getPhaseListeners
public abstract PhaseListener[] getPhaseListeners()
この
Lifecycleインスタンスに登録されているPhaseListenerのセットを返します。登録済みのリスナーがない場合は、長さ 0 の配列が返されます。- 戻り値:
- 登録された
PhaseListenerのセット
removePhaseListener
public abstract void removePhaseListener(PhaseListener listener)
リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心がなくなった既存の
PhaseListenerインスタンスの登録を解除します。そのようなリスナーインスタンスが登録されていない場合、アクションは実行されません。- パラメーター:
listener- 登録解除するPhaseListener- 例外:
NullPointerExceptionSE-listenerがnullの場合
render
public abstract void render(FacesContext context) throws FacesException
現在のリクエストに関連付けられている
FacesContextインスタンスでresponseComplete()メソッドが呼び出されていない限り、リクエスト処理ライフサイクルのレスポンスのレンダリングフェーズを実行します。- パラメーター:
context- 処理中のリクエストの FacesContext- 例外:
FacesException- リクエスト処理ライフサイクルの実行中に例外がスローされた場合NullPointerExceptionSE-contextがnullの場合