クラス 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 void
addPhaseListener(PhaseListener listener)
リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知されることに関心のある新しいPhaseListener
インスタンスを登録します。void
attachWindow(FacesContext context)
ライフサイクル全体でこの実行のUIViewRoot
を表示するために使用するClientWindow
を作成または復元します。abstract void
execute(FacesContext context)
Jakarta Faces Specification Document のセクション 2「リクエスト処理ライフサイクル」に従って、Render Response フェーズまでのリクエスト処理ライフサイクルのすべてのフェーズを指定された順序で実行します。abstract PhaseListener[]
getPhaseListeners()
このLifecycle
インスタンスに登録されているPhaseListener
のセットを返します。abstract void
removePhaseListener(PhaseListener listener)
リクエスト処理ライフサイクルの標準フェーズの処理の前後に通知される必要がなくなった既存のPhaseListener
インスタンスを登録解除します。abstract void
render(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
の場合