クラス FacesContext
- java.lang.ObjectSE
-
- jakarta.faces.context.FacesContext
- 既知の直属サブクラス
FacesContextWrapper
public abstract class FacesContext extends ObjectSE
FacesContext には、単一の Jakarta Faces リクエストの処理、および対応するレスポンスのレンダリングに関連するリクエストごとの状態情報がすべて含まれています。リクエスト処理ライフサイクルの各フェーズに渡され、潜在的に変更されます。
FacesContextインスタンスは、現在の Web アプリケーションに関連付けられているFacesContextFactoryインスタンスのgetFacesContext()メソッドの呼び出しによって、リクエスト処理の最初に特定のリクエストに関連付けられます。release()メソッドが呼び出されるまでインスタンスはアクティブのままです。その後、このインスタンスへの参照は許可されません。FacesContextインスタンスはアクティブですが、この Web アプリケーションを実行する Jakarta Servlet コンテナーがこのリクエストの処理に利用するスレッド以外のスレッドから参照してはなりません。FacesContext は、
@Inject FacesContext facesContext;を使用して、Bean をスコープとするリクエストに挿入できます。
コンストラクターの概要
コンストラクター コンストラクター 説明 FacesContext()デフォルトコンストラクター。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract voidaddMessage(StringSE clientId, FacesMessage message)abstract ApplicationgetApplication()この Web アプリケーションに関連付けられているApplicationインスタンスを返します。MapSE<ObjectSE,ObjectSE>getAttributes()このFacesContextインスタンスに関連付けられた属性を表す変更可能なMapを返します。abstract IteratorSE<StringSE>getClientIdsWithMessages()少なくとも 1 つのFacesMessageがキューに入れられているクライアント識別子に対してIteratorを返します。static FacesContextgetCurrentInstance()現在のスレッドによって処理されているリクエストのFacesContextインスタンスを返します。PhaseIdgetCurrentPhaseId()setCurrentPhaseId(jakarta.faces.event.PhaseId)が呼び出されたときに、このFacesContextインスタンスに最後に設定された値を返します。ELContextgetELContext()このFacesContextインスタンスのELContextインスタンスを返します。ExceptionHandlergetExceptionHandler()このリクエストのExceptionHandlerを返します。abstract ExternalContextgetExternalContext()abstract LifecyclegetLifecycle()abstract FacesMessage.SeveritygetMaximumSeverity()特定のUIComponentに関連付けられているかどうかに関係なく、キューに入れられたFacesMessageに記録されている最大の重大度レベルを返します。ListSE<FacesMessage>getMessageList()getMessages()と同様ですが、List<FacesMessage>を返し、Jakarta Expression Language 式からの使用を可能にします。ListSE<FacesMessage>getMessageList(StringSE clientId)getMessages(java.lang.String)に似ていますが、クライアント ID が引数clientIdに一致するコンポーネントのメッセージのList<FacesMessage>を返します。abstract IteratorSE<FacesMessage>getMessages()特定のクライアント識別子に関連付けられているかどうかに関係なく、キューに入れられたFacesMessageを介してIteratorを返します。abstract IteratorSE<FacesMessage>getMessages(StringSE clientId)指定されたクライアント識別子に関連付けられているキューに登録されているFacesMessageを介してIteratorを返します(clientIdがnullでない場合)、または特定のクライアント識別子に関連付けられていないキューに登録されているFacesMessageを返します(clientIdがnullの場合))。chargetNamingContainerSeparatorChar()thisを引数として渡して、UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)を呼び出した結果を返します。PartialViewContextgetPartialViewContext()このリクエストのPartialViewContextを返します。abstract RenderKitgetRenderKit()UIViewRootに指定されているレンダーキット識別子のRenderKitインスタンスがある場合は、それを返します。abstract booleangetRenderResponse()現在のリクエストに対してrenderResponse()メソッドが呼び出された場合は、trueを返します。ListSE<StringSE>getResourceLibraryContracts()このビューでの使用に適切であると計算されたリソースライブラリ契約のリストを返します。そのようなリソースライブラリ契約がない場合は空のリストを返します。abstract booleangetResponseComplete()現在のリクエストに対してresponseComplete()メソッドが呼び出された場合は、trueを返します。abstract ResponseStreamgetResponseStream()コンポーネントがバイナリ出力を送信する先のResponseStreamを返します。abstract ResponseWritergetResponseWriter()コンポーネントが文字ベースの出力を送信する先のResponseWriterを返します。abstract UIViewRootgetViewRoot()このリクエストに関連付けられているルートコンポーネントを返します。booleanisPostback()このユーティリティメソッドは、単にResponseStateManager.isPostback(FacesContext)の結果を返します。booleanisProcessingEvents()ランタイムがイベントをパブリッシュする必要があるかどうかを示すフラグを返します。booleanisProjectStage(ProjectStage stage)booleanisReleased()このFacesContextインスタンスに関連付けられているリソースが解放されているかどうかを示すフラグを返します。booleanisValidationFailed()現在のリクエストに対してvalidationFailed()メソッドが呼び出された場合は、trueを返します。abstract voidrelease()このFacesContextインスタンスに関連付けられたすべてのリソースを解放します。abstract voidrenderResponse()リクエスト処理ライフサイクルの現在のフェーズが完了するとすぐに、制御がレンダリングレスポンスフェーズに渡され、まだ実行されていないフェーズをバイパスする必要があることを Jakarta Faces 実装に通知します。abstract voidresponseComplete()このリクエストの HTTP レスポンスがすでに生成されていること(HTTP リダイレクトなど)と、現在のフェーズが完了したらすぐにリクエスト処理ライフサイクルを終了する必要があることを Jakarta Faces 実装に通知します。protected static voidsetCurrentInstance(FacesContext context)現在のスレッドによって処理されているリクエストのFacesContextインスタンスを設定します。voidsetCurrentPhaseId(PhaseId currentPhaseId)実装は、リクエスト処理ライフサイクルの新しいフェーズに入った後、できるだけ早い時点でこのメソッドを呼び出す必要があります。voidsetExceptionHandler(ExceptionHandler exceptionHandler)このリクエストのExceptionHandlerを設定します。voidsetProcessingEvents(boolean processingEvents)Application.publishEvent(FacesContext, Class, Object)またはApplication.publishEvent(FacesContext, Class, Class, Object)が呼び出されたときにランタイムがイベントをパブリッシュするかどうかの制御を許可します。voidsetResourceLibraryContracts(ListSE<StringSE> contracts)このビューで使用できるように計算されたリソースライブラリ契約を設定します。abstract voidsetResponseStream(ResponseStream responseStream)コンポーネントがバイナリ出力を送信するResponseStreamを設定します。abstract voidsetResponseWriter(ResponseWriter responseWriter)コンポーネントが文字ベースの出力を送信するResponseWriterを設定します。abstract voidsetViewRoot(UIViewRoot root)このリクエストに関連付けられているルートコンポーネントを設定します。voidvalidationFailed()入力の処理中に変換または検証エラーが発生したことを示すフラグを設定します。
メソッドの詳細
getApplication
public abstract Application getApplication()
この Web アプリケーションに関連付けられている
Applicationインスタンスを返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動またはシャットダウン中に呼び出された場合、正しい現在の
Applicationインスタンスを返します。- 戻り値:
- この Web アプリケーションに関連付けられている
Applicationインスタンス。 - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getAttributes
public MapSE<ObjectSE,ObjectSE> getAttributes()
この
FacesContextインスタンスに関連付けられた属性を表す変更可能なMapを返します。このMapは、現在のリクエストの Faces ライフサイクルが終了したときにスコープから外したい属性を保存できます。これは、リクエストの終了と常に同じとは限りません。特に、Faces ライフサイクルの後に呼び出される Jakarta Servlet フィルターの場合はそうです。このリクエストのために完了します。このMapにアクセスしても、他のマップ(リクエスト、セッション、アプリケーションスコープ)の場合のように、イベントは発生しません。release()が呼び出されると、属性をクリアする必要があります。このメソッドによって返される
Mapは、リクエストに関連付けられていません。リクエスト属性を取得または設定したい場合は、ExternalContext.getRequestMap()を参照してください。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- この
FacesContextインスタンスに関連付けられた属性を表す可変Map。 - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
getPartialViewContext
public PartialViewContext getPartialViewContext()
このリクエストの
PartialViewContextを返します。PartialViewContextは、リクエスト処理ライフサイクルの実行部分(指定された部分処理と呼ばれます)中の指定されたコンポーネントの処理と指定されたコンポーネントの表示(指定されたレンダリングと呼ばれます)を制御するために使用されます。存在しない場合、このメソッドは新しいPartialViewContextを返す必要があります。- 戻り値:
- このリクエストの
PartialViewContextのインスタンス。 - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
getClientIdsWithMessages
public abstract IteratorSE<StringSE> getClientIdsWithMessages()
少なくとも 1 つの
FacesMessageがキューに入れられているクライアント識別子に対してIteratorを返します。そのようなクライアント識別子がない場合、空のIteratorが返されます。特定のクライアント識別子に関連付けられていないメッセージがキューに登録されている場合、null値が反復値に含まれます。Iteratorの要素は、addMessage(java.lang.String, jakarta.faces.application.FacesMessage)で追加された順序で返される必要があります。- 戻り値:
- 少なくとも 1 つの
FacesMessageがキューに入れられたクライアント識別子を介したIterator - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getELContext
public ELContext getELContext()
この
FacesContextインスタンスのELContextインスタンスを返します。このELContextインスタンスは、関連付けられているFacesContextインスタンスと同じ存続期間とスコープを持ち、このメソッドが特定のFacesContextインスタンスに対して初めて呼び出されたときに、遅延して作成される場合があります。ELContext インスタンスの作成時に、実装は次のアクションを実行する必要があります。インスタンスで
ELContext.putContext(java.lang.Class<?>, java.lang.Object)メソッドを呼び出し、FacesContextインスタンス自体のFacesContext.classおよびthis参照を渡します。Application.getELContextListeners()によって返されたCollectionが空でない場合は、ELContextEventのインスタンスを作成し、ELContextListener.contextCreated(jakarta.el.ELContextEvent)メソッドを呼び出して、Collectionの各ELContextListenerインスタンスに渡します。
- 戻り値:
ELContextのインスタンス。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 1.2
getExceptionHandler
public ExceptionHandler getExceptionHandler()
このリクエストの
ExceptionHandlerを返します。- 戻り値:
ExceptionHandlerのインスタンス。
setExceptionHandler
public void setExceptionHandler(ExceptionHandler exceptionHandler)
このリクエストの
ExceptionHandlerを設定します。- パラメーター:
exceptionHandler- このリクエストのExceptionHandler
getLifecycle
public abstract Lifecycle getLifecycle()
この
FacesContextインスタンスのLifecycleインスタンスを返します。- 戻り値:
Lifecycleのインスタンス- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 4.0
getExternalContext
public abstract ExternalContext getExternalContext()
この
FacesContextインスタンスのExternalContextインスタンスを返します。アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出された場合、このメソッドは、そのクラスの javadoc に示されている特別な動作を持つ
ExternalContextインスタンスを返します。メソッドのドキュメントは、アプリケーションの起動時またはシャットダウン時に呼び出すことが有効であることをサポートする必要があります。- 戻り値:
ExternalContextのインスタンス- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getMaximumSeverity
public abstract FacesMessage.Severity getMaximumSeverity()
特定の
UIComponentに関連付けられているかどうかに関係なく、キューに入っているFacesMessageに記録されている最大の重大度レベルを返します。そのようなメッセージがキューに入っていない場合は、nullを返します。- 戻り値:
- 最大の重大度レベル。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getMessages
public abstract IteratorSE<FacesMessage> getMessages()
特定のクライアント識別子に関連付けられているかどうかに関係なく、キューに入れられた
FacesMessageを介してIteratorを返します。そのようなメッセージがキューに入っていない場合は、空のIteratorを返します。Iteratorの要素は、addMessage(java.lang.String, jakarta.faces.application.FacesMessage)の呼び出しで追加された順序で返される必要があります。- 戻り値:
- キューに入れられた
FacesMessageよりIterator。 - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getMessageList
public ListSE<FacesMessage> getMessageList()
getMessages()と同様ですが、List<FacesMessage>を返し、Jakarta Expression Language 式からの使用を可能にします。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- 呼び出し時に存在するメッセージのスナップショットである不変の
List - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
getMessageList
public ListSE<FacesMessage> getMessageList(StringSE clientId)
getMessages(java.lang.String)に似ていますが、クライアント ID が引数clientIdに一致するコンポーネントのメッセージのList<FacesMessage>を返します。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- パラメーター:
clientId- コンポーネントのクライアント ID。- 戻り値:
- 呼び出し時に存在するメッセージのスナップショットである不変の
List - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
getMessages
public abstract IteratorSE<FacesMessage> getMessages(StringSE clientId)
指定されたクライアント識別子に関連付けられているキューに入れられた
FacesMessageを介してIteratorを返します(clientIdがnullでない場合)、または特定のクライアント識別子に関連付けられていないキューに入れられたFacesMessageを返します(clientIdがnullの場合))。そのようなメッセージがキューに入っていない場合は、空のIteratorを返します。Iteratorの要素は、addMessage(java.lang.String, jakarta.faces.application.FacesMessage)への呼び出しで追加された順序で返される必要があります。- パラメーター:
clientId- メッセージがリクエストされたクライアント識別子、またはクライアント識別子に関連付けられていないメッセージのnull- 戻り値:
-
FacesMessage上のIterator。 - 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getNamingContainerSeparatorChar
public char getNamingContainerSeparatorChar()
thisを引数として渡して、UINamingContainer.getSeparatorChar(jakarta.faces.context.FacesContext)を呼び出した結果を返します。これにより、Jakarta Expression Language 式#{facesContext.namingContainerSeparatorChar}からこのプロパティの値にアクセスできるようになることに注意してください。- 戻り値:
- セパレータ文字。
getRenderKit
public abstract RenderKit getRenderKit()
UIViewRootに指定されているレンダーキット識別子のRenderKitインスタンスがある場合は、それを返します。現在のUIViewRootがない場合、UIViewRootに指定されたrenderKitIdがない場合、指定された識別子のRenderKitがない場合は、代わりにnullを返します。- 戻り値:
UIViewRootに関連付けられたRenderKitのインスタンス。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getRenderResponse
public abstract boolean getRenderResponse()
現在のリクエストに対して
renderResponse()メソッドが呼び出された場合は、trueを返します。- 戻り値:
renderResponse()が呼び出されたかどうかを示すフラグ。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getResponseComplete
public abstract boolean getResponseComplete()
現在のリクエストに対して
responseComplete()メソッドが呼び出された場合は、trueを返します。- 戻り値:
responseComplete()メソッドが呼び出されたかどうかを示すブール値。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getResourceLibraryContracts
public ListSE<StringSE> getResourceLibraryContracts()
このビューでの使用に適切であると計算されたリソースライブラリ契約のリストを返します。そのようなリソースライブラリ契約がない場合は空のリストを返します。このメソッドによって返されるリストは不変でなければなりません。このメソッドが導入される前の仕様の実装との下位互換性のために、空のリストを返す実装が提供されています。このメソッドが導入されたバージョンに準拠した実装は、このメソッドを指定どおりに実装する必要があります。
- 戻り値:
- リソースライブラリ契約のリスト。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.2
setResourceLibraryContracts
public void setResourceLibraryContracts(ListSE<StringSE> contracts)
このビューで使用できるように計算されたリソースライブラリ契約を設定します。実装は、
getResourceLibraryContracts()から戻るために、受信Listの内容を不変のListにコピーする必要があります。引数がnullまたは空の場合、実行されるアクションは、引数がnullの場合と同じです。後続のgetResourceLibraryContractsへの呼び出しはnullを返します。このメソッドは、ViewDeclarationLanguage.createView(jakarta.faces.context.FacesContext, java.lang.String)の処理中、UIViewRootのインスタンスに対応するタグの VDL タグハンドラー中にのみ呼び出すことができます。このメソッドが導入される前の仕様の実装との下位互換性のために、アクションを実行しない実装が提供されています。このメソッドが導入されたバージョンに準拠した実装は、このメソッドを指定どおりに実装する必要があります。- パラメーター:
contracts- 不変のListとして返される新しい契約。getResourceLibraryContracts()への後続の呼び出しから。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.2
isValidationFailed
public boolean isValidationFailed()
現在のリクエストに対して
validationFailed()メソッドが呼び出された場合は、trueを返します。- 戻り値:
validationFailed()メソッドが現在のリクエストに対して呼び出されたかどうかを示すブール値- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getResponseStream
public abstract ResponseStream getResponseStream()
コンポーネントがバイナリ出力を送信する
ResponseStreamを返します。特定のレスポンス内で、コンポーネントは ResponseStream または ResponseWriter のいずれかを使用できますが、両方を使用することはできません。- 戻り値:
ResponseStreamインスタンス。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
setResponseStream
public abstract void setResponseStream(ResponseStream responseStream)
コンポーネントがバイナリ出力を送信する
ResponseStreamを設定します。- パラメーター:
responseStream- このレスポンスの新しい ResponseStream- 例外:
NullPointerExceptionSE-responseStreamがnullの場合IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getResponseWriter
public abstract ResponseWriter getResponseWriter()
コンポーネントが文字ベースの出力を送信する先の
ResponseWriterを返します。特定のレスポンス内で、コンポーネントは ResponseStream または ResponseWriter のいずれかを使用できますが、両方を使用することはできません。- 戻り値:
ResponseWriterインスタンス。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
setResponseWriter
public abstract void setResponseWriter(ResponseWriter responseWriter)
コンポーネントが文字ベースの出力を送信する
ResponseWriterを設定します。- パラメーター:
responseWriter- このレスポンスの新しい ResponseWriter- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合NullPointerExceptionSE-responseWriterがnullの場合
getViewRoot
public abstract UIViewRoot getViewRoot()
このリクエストに関連付けられているルートコンポーネントを返します。
アプリケーションの起動時またはシャットダウン時にこのメソッドを呼び出すことは有効です。アプリケーションの起動時またはシャットダウン時に呼び出された場合、このメソッドはロケールを
Locale.getDefault()に設定した新しいUIViewRootを返します。- 戻り値:
UIViewRootインスタンス。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
setViewRoot
public abstract void setViewRoot(UIViewRoot root)
このリクエストに関連付けられているルートコンポーネントを設定します。
このメソッドは、アプリケーションハンドラー(またはハンドラーが呼び出すクラス)によって、リクエスト処理ライフサイクルのアプリケーションの呼び出しフェーズ中、およびリクエスト処理ライフサイクルのビューの復元フェーズ中に(特に新しいルートコンポーネントが作成されたとき)呼び出すことができます。仕様の現在のバージョンでは、実装はこの制限を強制する必要はありませんが、仕様の将来のバージョンでは強制が必要になる可能性があります。
現在の
UIViewRootが非 nullであり、引数rootでequals()を呼び出すと、現在のUIViewRootを渡すとfalseが返され、UIViewRoot.getViewMap()から返されたMapでclearメソッドを呼び出す必要があります。- パラメーター:
root- 新しいコンポーネントUIViewRootコンポーネント- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合NullPointerExceptionSE-rootがnullの場合
addMessage
public abstract void addMessage(StringSE clientId, FacesMessage message)
clientIdがnullでない場合は、指定されたクライアント識別子に関連付けられたメッセージのセットにFacesMessageを追加します。clientIdがnullの場合、このFacesMessageは特定のコンポーネントインスタンスに関連付けられていないと見なされます。- パラメーター:
clientId- このメッセージが関連付けられているクライアント識別子 (もしあれば)message- 追加するメッセージ- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合NullPointerExceptionSE-messageがnullの場合
isReleased
public boolean isReleased()
この
FacesContextインスタンスに関連付けられているリソースが解放されているかどうかを示すフラグを返します。- 戻り値:
trueリソースが解放されている場合。- 導入:
- 2.1
release
public abstract void release()
この
FacesContextインスタンスに関連付けられたすべてのリソースを解放します。Faces の実装では、関連するFacesContextFactoryのインスタンスをプールして、オブジェクトの作成とガベージコレクションが繰り返されないようにすることができます。FacesContextインスタンスでrelease()が呼び出された後(FacesContextインスタンスが再利用のために実装によってリサイクルされるまで)、他のメソッドを呼び出すとIllegalStateExceptionがスローされます。このリクエストの処理中に
getAttributes()が呼び出された場合、実装はgetAttributes()から返されたMapでclear()を呼び出し、そのMapの背後にあるデータ構造の割り当てを解除する必要があります。実装は、
nullを渡してsetCurrentInstance(jakarta.faces.context.FacesContext)を呼び出し、このスレッドとこの無効なFacesContextインスタンス間の関連付けを削除する必要があります。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
renderResponse
public abstract void renderResponse()
リクエスト処理ライフサイクルの現在のフェーズが完了するとすぐに、制御がレンダリングレスポンスフェーズに渡され、まだ実行されていないフェーズをバイパスする必要があることを Jakarta Faces 実装に通知します。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
isPostback
public boolean isPostback()
このユーティリティメソッドは、単に
ResponseStateManager.isPostback(FacesContext)の結果を返します。デフォルトの実装は
UnsupportedOperationExceptionをスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。- 戻り値:
- このリクエストが投稿リクエストかどうかを示すブール値。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
responseComplete
public abstract void responseComplete()
このリクエストの HTTP レスポンスがすでに生成されていること(HTTP リダイレクトなど)と、現在のフェーズが完了したらすぐにリクエスト処理ライフサイクルを終了する必要があることを Jakarta Faces 実装に通知します。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
validationFailed
public void validationFailed()
入力の処理中に変換または検証エラーが発生したことを示すフラグを設定します。入力は、ページパラメーターまたはフォームバインディングのいずれかで構成されます。このフラグは
isValidationFailed()を使用して読み取ることができます。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合
getCurrentPhaseId
public PhaseId getCurrentPhaseId()
setCurrentPhaseId(jakarta.faces.event.PhaseId)が呼び出されたときに、このFacesContextインスタンスに最後に設定された値を返します。- 戻り値:
- 現在のフェーズ ID。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
setCurrentPhaseId
public void setCurrentPhaseId(PhaseId currentPhaseId)
実装は、リクエスト処理ライフサイクルの新しいフェーズに入った後、できるだけ早い時点でこのメソッドを呼び出す必要があります。
- パラメーター:
currentPhaseId- 現在のフェーズのPhaseId。- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合- 導入:
- 2.0
setProcessingEvents
public void setProcessingEvents(boolean processingEvents)
Application.publishEvent(FacesContext, Class, Object)またはApplication.publishEvent(FacesContext, Class, Class, Object)が呼び出されたときにランタイムがイベントをパブリッシュするかどうかの制御を許可します。- パラメーター:
processingEvents- イベントを処理する必要があるかどうかを示すフラグ
isProcessingEvents
public boolean isProcessingEvents()
ランタイムがイベントをパブリッシュする必要があるかどうかを示すフラグを返します。
- 戻り値:
- イベントを公開する必要がある場合は
true、それ以外の場合はfalse
isProjectStage
public boolean isProjectStage(ProjectStage stage)
Applicationインスタンスによって返された現在のProjectStageがstageと等しい場合はtrueを返し、それ以外の場合はfalseを返します- パラメーター:
stage- チェックするProjectStage- 戻り値:
- アプリケーションに同じステージがあるかどうかを示すブール。
- 例外:
IllegalStateExceptionSE- このインスタンスが解放された後にこのメソッドが呼び出された場合NullPointerExceptionSE-stageがnullの場合
getCurrentInstance
public static FacesContext getCurrentInstance()
現在のスレッドによって処理されているリクエストの
FacesContextインスタンスを返します。アプリケーションの初期化中またはシャットダウン中に呼び出される場合、「アプリケーションの起動中またはシャットダウン中にこのメソッドを呼び出すことが有効」と記載されているメソッドは、アプリケーションの起動中またはシャットダウン中にサポートされる必要があります。この指定のないアプリケーションの起動時またはシャットダウン時にメソッドを呼び出した結果は未定義です。- 戻り値:
FacesContextのインスタンス。
setCurrentInstance
protected static void setCurrentInstance(FacesContext context)
現在のスレッドによって処理されているリクエストの
FacesContextインスタンスを設定します。- パラメーター:
context- 現在のスレッドのFacesContextインスタンス、またはこのスレッドにFacesContextインスタンスがなくなった場合はnull。