Jakarta EE 11.0.0 · jakarta.faces.context.FacesContextWrapper

Modifier and Type	Field and Description
private FacesContext	wrapped

Access	Constructor and Description
public	FacesContextWrapper() Deprecated Use the other constructor taking the implementation being wrapped.
public	FacesContextWrapper(FacesContext The implementation being wrapped. wrapped) If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Modifier and Type	Method and Description
public void	addMessage(String The client identifier with which this message is associated (if any) clientId, FacesMessage The message to be appended message) Implements abstract jakarta.faces.context.FacesContext.addMessage. The default behavior of this method is to call `FacesContext#addMessage(String, FacesMessage)` on the wrapped `FacesContext` object.
public Application	getApplication() Implements abstract jakarta.faces.context.FacesContext.getApplication. The default behavior of this method is to call `FacesContext#getApplication()` on the wrapped `FacesContext` object.
public Map<Object, Object>	getAttributes() Overrides jakarta.faces.context.FacesContext.getAttributes. The default behavior of this method is to call `FacesContext#getAttributes()` on the wrapped `FacesContext` object.
public Iterator<String>	getClientIdsWithMessages() Implements abstract jakarta.faces.context.FacesContext.getClientIdsWithMessages. The default behavior of this method is to call `jakarta.faces.context.FacesContext#getClientIdsWithMessages()` on the wrapped `FacesContext` object.
public PhaseId	getCurrentPhaseId() Overrides jakarta.faces.context.FacesContext.getCurrentPhaseId. The default behavior of this method is to call `FacesContext#getCurrentPhaseId()` on the wrapped `FacesContext` object.
public ELContext	getELContext() Overrides jakarta.faces.context.FacesContext.getELContext. The default behavior of this method is to call `FacesContext#getELContext()` on the wrapped `FacesContext` object.
public ExceptionHandler	getExceptionHandler() Overrides jakarta.faces.context.FacesContext.getExceptionHandler. The default behavior of this method is to call `FacesContext#getExceptionHandler()` on the wrapped `FacesContext` object.
public ExternalContext	getExternalContext() Implements abstract jakarta.faces.context.FacesContext.getExternalContext. The default behavior of this method is to call `FacesContext#getExternalContext()` on the wrapped `FacesContext` object.
public Lifecycle	getLifecycle() Implements abstract jakarta.faces.context.FacesContext.getLifecycle. The default behavior of this method is to call `FacesContext#getLifecycle()` on the wrapped `FacesContext` object.
public FacesMessage.Severity	getMaximumSeverity() Implements abstract jakarta.faces.context.FacesContext.getMaximumSeverity. The default behavior of this method is to call `FacesContext#getMaximumSeverity()` on the wrapped `FacesContext` object.
public List<FacesMessage>	getMessageList() Overrides jakarta.faces.context.FacesContext.getMessageList. The default behavior of this method is to call `FacesContext#getMessageList()` on the wrapped `FacesContext` object.
public List<FacesMessage>	getMessageList(String the client id of a component. clientId) Overrides jakarta.faces.context.FacesContext.getMessageList. The default behavior of this method is to call `FacesContext#getMessageList(String)` on the wrapped `FacesContext` object.
public Iterator<FacesMessage>	getMessages() Implements abstract jakarta.faces.context.FacesContext.getMessages. The default behavior of this method is to call `FacesContext#getMessages()` on the wrapped `FacesContext` object.
public Iterator<FacesMessage>	getMessages(String The client identifier for which messages are requested, or `null` for messages not associated with any client identifier clientId) Implements abstract jakarta.faces.context.FacesContext.getMessages. The default behavior of this method is to call `FacesContext#getMessages(String)` on the wrapped `FacesContext` object.
public char	getNamingContainerSeparatorChar() Overrides jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar. The default behavior of this method is to call `FacesContext#getNamingContainerSeparatorChar()` on the wrapped `FacesContext` object.
public PartialViewContext	getPartialViewContext() Overrides jakarta.faces.context.FacesContext.getPartialViewContext. The default behavior of this method is to call `FacesContext#getPartialViewContext()` ()} on the wrapped `FacesContext` object.
public RenderKit	getRenderKit() Implements abstract jakarta.faces.context.FacesContext.getRenderKit. The default behavior of this method is to call `FacesContext#getRenderKit()` on the wrapped `FacesContext` object.
public boolean	getRenderResponse() Implements abstract jakarta.faces.context.FacesContext.getRenderResponse. The default behavior of this method is to call `FacesContext#getRenderResponse()` on the wrapped `FacesContext` object.
public List<String>	getResourceLibraryContracts() Overrides jakarta.faces.context.FacesContext.getResourceLibraryContracts. The default behavior of this method is to call `FacesContext#getResourceLibraryContracts` on the wrapped `FacesContext` object.
public boolean	getResponseComplete() Implements abstract jakarta.faces.context.FacesContext.getResponseComplete. The default behavior of this method is to call `FacesContext#getResponseComplete()` on the wrapped `FacesContext` object.
public ResponseStream	getResponseStream() Implements abstract jakarta.faces.context.FacesContext.getResponseStream. The default behavior of this method is to call `FacesContext#getResponseStream()` on the wrapped `FacesContext` object.
public ResponseWriter	getResponseWriter() Implements abstract jakarta.faces.context.FacesContext.getResponseWriter. The default behavior of this method is to call `FacesContext#getResponseWriter()` on the wrapped `FacesContext` object.
public UIViewRoot	getViewRoot() Implements abstract jakarta.faces.context.FacesContext.getViewRoot. The default behavior of this method is to call `FacesContext#getViewRoot()` on the wrapped `FacesContext` object.
public FacesContext	getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped.
public boolean	isPostback() Overrides jakarta.faces.context.FacesContext.isPostback. The default behavior of this method is to call `FacesContext#isPostback()` on the wrapped `FacesContext` object.
public boolean	isProcessingEvents() Overrides jakarta.faces.context.FacesContext.isProcessingEvents. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isProcessingEvents()` on the wrapped `FacesContext` object.
public boolean	isProjectStage(ProjectStage the `ProjectStage` to check stage) Overrides jakarta.faces.context.FacesContext.isProjectStage. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage)` on the wrapped `FacesContext` object.
public boolean	isReleased() Overrides jakarta.faces.context.FacesContext.isReleased. The default behavior of this method is to call `FacesContext#isReleased` on the wrapped `FacesContext` object.
public boolean	isValidationFailed() Overrides jakarta.faces.context.FacesContext.isValidationFailed. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isValidationFailed` on the wrapped `FacesContext` object.
public void	release() Implements abstract jakarta.faces.context.FacesContext.release. The default behavior of this method is to call `FacesContext#release()` on the wrapped `FacesContext` object.
public void	renderResponse() Implements abstract jakarta.faces.context.FacesContext.renderResponse. The default behavior of this method is to call `FacesContext#renderResponse()` on the wrapped `FacesContext` object.
public void	responseComplete() Implements abstract jakarta.faces.context.FacesContext.responseComplete. The default behavior of this method is to call `FacesContext#responseComplete()` on the wrapped `FacesContext` object.
public void	setCurrentPhaseId(PhaseId The `jakarta.faces.event.PhaseId` for the current phase. currentPhaseId) Overrides jakarta.faces.context.FacesContext.setCurrentPhaseId. The default behavior of this method is to call `FacesContext#setCurrentPhaseId(PhaseId)` on the wrapped `FacesContext` object.
public void	setExceptionHandler(ExceptionHandler the `ExceptionHandler` for this request. exceptionHandler) Overrides jakarta.faces.context.FacesContext.setExceptionHandler. The default behavior of this method is to call `FacesContext#setExceptionHandler(ExceptionHandler)` on the wrapped `FacesContext` object.
public void	setProcessingEvents(boolean flag indicating events should be processed or not processingEvents) Overrides jakarta.faces.context.FacesContext.setProcessingEvents. The default behavior of this method is to call `FacesContext#setProcessingEvents(boolean)` on the wrapped `FacesContext` object.
public void	setResourceLibraryContracts(List<String> The new contracts to be returned, as an immutable `List`. from a subsequent call to `getResourceLibraryContracts`. contracts) Overrides jakarta.faces.context.FacesContext.setResourceLibraryContracts. The default behavior of this method is to call `FacesContext#setResourceLibraryContracts` on the wrapped `FacesContext` object.
public void	setResponseStream(ResponseStream The new ResponseStream for this response responseStream) Implements abstract jakarta.faces.context.FacesContext.setResponseStream. The default behavior of this method is to call `FacesContext#setResponseStream(ResponseStream)` on the wrapped `FacesContext` object.
public void	setResponseWriter(ResponseWriter The new ResponseWriter for this response responseWriter) Implements abstract jakarta.faces.context.FacesContext.setResponseWriter. The default behavior of this method is to call `FacesContext#setResponseWriter(ResponseWriter)` on the wrapped `FacesContext` object.
public void	setViewRoot(UIViewRoot The new component `UIViewRoot` component root) Implements abstract jakarta.faces.context.FacesContext.setViewRoot. The default behavior of this method is to call `FacesContext#setViewRoot(UIViewRoot)` on the wrapped `FacesContext` object.
public void	validationFailed() Overrides jakarta.faces.context.FacesContext.validationFailed. The default behavior of this method is to call `jakarta.faces.context.FacesContext#validationFailed()` on the wrapped `FacesContext` object.

wrapped	back to summary
private FacesContext wrapped

FacesContextWrapper	back to summary
public FacesContextWrapper() Deprecated Use the other constructor taking the implementation being wrapped. Annotations @Deprecated

FacesContextWrapper	back to summary
public FacesContextWrapper(FacesContext wrapped) If this faces context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The `getWrapped()` will then return the implementation being wrapped. Parameters wrapped:FacesContext The implementation being wrapped. Since 2.3

Method Detail

addMessage back to summary

addMessage	back to summary
public void addMessage(String clientId, FacesMessage message) Implements abstract jakarta.faces.context.FacesContext.addMessage. The default behavior of this method is to call `FacesContext#addMessage(String, FacesMessage)` on the wrapped `FacesContext` object. Parameters clientId:String Doc from jakarta.faces.context.FacesContext.addMessage. The client identifier with which this message is associated (if any) message:FacesMessage Doc from jakarta.faces.context.FacesContext.addMessage. The message to be appended Annotations @Override See Also `jakarta.faces.context.FacesContext#addMessage(String, FacesMessage)`

public void addMessage(String clientId, FacesMessage message)

Implements abstract jakarta.faces.context.FacesContext.addMessage.

The default behavior of this method is to call FacesContext#addMessage(String, FacesMessage) on the wrapped FacesContext object.

Parameters

clientId:String

Doc from jakarta.faces.context.FacesContext.addMessage.

The client identifier with which this message is associated (if any)

message:FacesMessage

Doc from jakarta.faces.context.FacesContext.addMessage.

The message to be appended

Annotations

@Override

getApplication back to summary

getApplication	back to summary
public Application getApplication() Implements abstract jakarta.faces.context.FacesContext.getApplication. The default behavior of this method is to call `FacesContext#getApplication()` on the wrapped `FacesContext` object. Returns:Application Doc from jakarta.faces.context.FacesContext.getApplication. the `Application` instance associated with this web application. Annotations @Override See Also `jakarta.faces.context.FacesContext#getApplication()`

public Application getApplication()

Implements abstract jakarta.faces.context.FacesContext.getApplication.

The default behavior of this method is to call FacesContext#getApplication() on the wrapped FacesContext object.

Returns:Application

Doc from jakarta.faces.context.FacesContext.getApplication.

the Application instance associated with this web application.

Annotations

@Override

getAttributes back to summary

getAttributes	back to summary
public Map<Object, Object> getAttributes() Overrides jakarta.faces.context.FacesContext.getAttributes. The default behavior of this method is to call `FacesContext#getAttributes()` on the wrapped `FacesContext` object. Returns:Map<Object, Object> Doc from jakarta.faces.context.FacesContext.getAttributes. mutable `Map` representing the attributes associated wth this `FacesContext` instance. Annotations @Override See Also `jakarta.faces.context.FacesContext#getAttributes()`

public Map<Object, Object> getAttributes()

Overrides jakarta.faces.context.FacesContext.getAttributes.

The default behavior of this method is to call FacesContext#getAttributes() on the wrapped FacesContext object.

Returns:Map<Object, Object>

Doc from jakarta.faces.context.FacesContext.getAttributes.

mutable Map representing the attributes associated wth this FacesContext instance.

Annotations

@Override

getClientIdsWithMessages back to summary

getClientIdsWithMessages	back to summary
public Iterator<String> getClientIdsWithMessages() Implements abstract jakarta.faces.context.FacesContext.getClientIdsWithMessages. The default behavior of this method is to call `jakarta.faces.context.FacesContext#getClientIdsWithMessages()` on the wrapped `FacesContext` object. Returns:Iterator<String> Doc from jakarta.faces.context.FacesContext.getClientIdsWithMessages. the `Iterator` over the client identifiers for which at least one `jakarta.faces.application.FacesMessage` has been queued. Annotations @Override See Also `FacesContext#getClientIdsWithMessages()`

public Iterator<String> getClientIdsWithMessages()

Implements abstract jakarta.faces.context.FacesContext.getClientIdsWithMessages.

The default behavior of this method is to call jakarta.faces.context.FacesContext#getClientIdsWithMessages() on the wrapped FacesContext object.

Returns:Iterator<String>

Doc from jakarta.faces.context.FacesContext.getClientIdsWithMessages.

the Iterator over the client identifiers for which at least one jakarta.faces.application.FacesMessage has been queued.

Annotations

@Override

getCurrentPhaseId back to summary

getCurrentPhaseId	back to summary
public PhaseId getCurrentPhaseId() Overrides jakarta.faces.context.FacesContext.getCurrentPhaseId. The default behavior of this method is to call `FacesContext#getCurrentPhaseId()` on the wrapped `FacesContext` object. Returns:PhaseId Doc from jakarta.faces.context.FacesContext.getCurrentPhaseId. the current phase id. Annotations @Override See Also `jakarta.faces.context.FacesContext#getCurrentPhaseId()`

public PhaseId getCurrentPhaseId()

Overrides jakarta.faces.context.FacesContext.getCurrentPhaseId.

The default behavior of this method is to call FacesContext#getCurrentPhaseId() on the wrapped FacesContext object.

Returns:PhaseId

Doc from jakarta.faces.context.FacesContext.getCurrentPhaseId.

the current phase id.

Annotations

@Override

getELContext back to summary

getELContext	back to summary
public ELContext getELContext() Overrides jakarta.faces.context.FacesContext.getELContext. The default behavior of this method is to call `FacesContext#getELContext()` on the wrapped `FacesContext` object. Returns:ELContext Doc from jakarta.faces.context.FacesContext.getELContext. instance of `ELContext`. Annotations @Override See Also `jakarta.faces.context.FacesContext#getELContext()`

public ELContext getELContext()

Overrides jakarta.faces.context.FacesContext.getELContext.

The default behavior of this method is to call FacesContext#getELContext() on the wrapped FacesContext object.

Returns:ELContext

Doc from jakarta.faces.context.FacesContext.getELContext.

instance of ELContext.

Annotations

@Override

getExceptionHandler back to summary

getExceptionHandler	back to summary
public ExceptionHandler getExceptionHandler() Overrides jakarta.faces.context.FacesContext.getExceptionHandler. The default behavior of this method is to call `FacesContext#getExceptionHandler()` on the wrapped `FacesContext` object. Returns:ExceptionHandler Doc from jakarta.faces.context.FacesContext.getExceptionHandler. instance of `ExceptionHandler`. Annotations @Override See Also `jakarta.faces.context.FacesContext#getExceptionHandler()`

public ExceptionHandler getExceptionHandler()

Overrides jakarta.faces.context.FacesContext.getExceptionHandler.

The default behavior of this method is to call FacesContext#getExceptionHandler() on the wrapped FacesContext object.

Returns:ExceptionHandler

Doc from jakarta.faces.context.FacesContext.getExceptionHandler.

instance of ExceptionHandler.

Annotations

@Override

getExternalContext back to summary

getExternalContext	back to summary
public ExternalContext getExternalContext() Implements abstract jakarta.faces.context.FacesContext.getExternalContext. The default behavior of this method is to call `FacesContext#getExternalContext()` on the wrapped `FacesContext` object. Returns:ExternalContext Doc from jakarta.faces.context.FacesContext.getExternalContext. instance of `ExternalContext` Annotations @Override See Also `jakarta.faces.context.FacesContext#getExternalContext()`

public ExternalContext getExternalContext()

Implements abstract jakarta.faces.context.FacesContext.getExternalContext.

The default behavior of this method is to call FacesContext#getExternalContext() on the wrapped FacesContext object.

Returns:ExternalContext

Doc from jakarta.faces.context.FacesContext.getExternalContext.

instance of ExternalContext

Annotations

@Override

getLifecycle back to summary

getLifecycle	back to summary
public Lifecycle getLifecycle() Implements abstract jakarta.faces.context.FacesContext.getLifecycle. The default behavior of this method is to call `FacesContext#getLifecycle()` on the wrapped `FacesContext` object. Returns:Lifecycle Doc from jakarta.faces.context.FacesContext.getLifecycle. instance of `Lifecycle` Annotations @Override See Also `jakarta.faces.context.FacesContext#getLifecycle()`

public Lifecycle getLifecycle()

Implements abstract jakarta.faces.context.FacesContext.getLifecycle.

The default behavior of this method is to call FacesContext#getLifecycle() on the wrapped FacesContext object.

Returns:Lifecycle

Doc from jakarta.faces.context.FacesContext.getLifecycle.

instance of Lifecycle

Annotations

@Override

getMaximumSeverity back to summary

getMaximumSeverity	back to summary
public FacesMessage.Severity getMaximumSeverity() Implements abstract jakarta.faces.context.FacesContext.getMaximumSeverity. The default behavior of this method is to call `FacesContext#getMaximumSeverity()` on the wrapped `FacesContext` object. Returns:FacesMessage.Severity Doc from jakarta.faces.context.FacesContext.getMaximumSeverity. the maximum severity level. Annotations @Override See Also `jakarta.faces.context.FacesContext#getMaximumSeverity()`

public FacesMessage.Severity getMaximumSeverity()

Implements abstract jakarta.faces.context.FacesContext.getMaximumSeverity.

The default behavior of this method is to call FacesContext#getMaximumSeverity() on the wrapped FacesContext object.

Returns:FacesMessage.Severity

Doc from jakarta.faces.context.FacesContext.getMaximumSeverity.

the maximum severity level.

Annotations

@Override

getMessageList back to summary

getMessageList	back to summary
public List<FacesMessage> getMessageList() Overrides jakarta.faces.context.FacesContext.getMessageList. The default behavior of this method is to call `FacesContext#getMessageList()` on the wrapped `FacesContext` object. Returns:List<FacesMessage> Doc from jakarta.faces.context.FacesContext.getMessageList. an immutable `List` which is effectively a snapshot of the messages present at the time of invocation. Annotations @Override See Also `jakarta.faces.context.FacesContext#getMessageList()`

public List<FacesMessage> getMessageList()

Overrides jakarta.faces.context.FacesContext.getMessageList.

The default behavior of this method is to call FacesContext#getMessageList() on the wrapped FacesContext object.

Returns:List<FacesMessage>

Doc from jakarta.faces.context.FacesContext.getMessageList.

an immutable List which is effectively a snapshot of the messages present at the time of invocation.

Annotations

@Override

getMessageList back to summary

getMessageList	back to summary
public List<FacesMessage> getMessageList(String clientId) Overrides jakarta.faces.context.FacesContext.getMessageList. The default behavior of this method is to call `FacesContext#getMessageList(String)` on the wrapped `FacesContext` object. Parameters clientId:String Doc from jakarta.faces.context.FacesContext.getMessageList. the client id of a component. Returns:List<FacesMessage> Doc from jakarta.faces.context.FacesContext.getMessageList. an immutable `List` which is effectively a snapshot of the messages present at the time of invocation. Annotations @Override See Also `jakarta.faces.context.FacesContext#getMessageList(String)`

public List<FacesMessage> getMessageList(String clientId)

Overrides jakarta.faces.context.FacesContext.getMessageList.

The default behavior of this method is to call FacesContext#getMessageList(String) on the wrapped FacesContext object.

Parameters

clientId:String

Doc from jakarta.faces.context.FacesContext.getMessageList.

the client id of a component.

Returns:List<FacesMessage>

Doc from jakarta.faces.context.FacesContext.getMessageList.

an immutable List which is effectively a snapshot of the messages present at the time of invocation.

Annotations

@Override

getMessages back to summary

getMessages	back to summary
public Iterator<FacesMessage> getMessages() Implements abstract jakarta.faces.context.FacesContext.getMessages. The default behavior of this method is to call `FacesContext#getMessages()` on the wrapped `FacesContext` object. Returns:Iterator<FacesMessage> Doc from jakarta.faces.context.FacesContext.getMessages. `Iterator` over the `FacesMessage`s that have been queued. Annotations @Override See Also `jakarta.faces.context.FacesContext#getMessages()`

public Iterator<FacesMessage> getMessages()

Implements abstract jakarta.faces.context.FacesContext.getMessages.

The default behavior of this method is to call FacesContext#getMessages() on the wrapped FacesContext object.

Returns:Iterator<FacesMessage>

Doc from jakarta.faces.context.FacesContext.getMessages.

Iterator over the FacesMessages that have been queued.

Annotations

@Override

getMessages back to summary

getMessages	back to summary
public Iterator<FacesMessage> getMessages(String clientId) Implements abstract jakarta.faces.context.FacesContext.getMessages. The default behavior of this method is to call `FacesContext#getMessages(String)` on the wrapped `FacesContext` object. Parameters clientId:String Doc from jakarta.faces.context.FacesContext.getMessages. The client identifier for which messages are requested, or `null` for messages not associated with any client identifier Returns:Iterator<FacesMessage> Doc from jakarta.faces.context.FacesContext.getMessages. `Iterator` over the `FacesMessage`s. Annotations @Override See Also `jakarta.faces.context.FacesContext#getMessages(String)`

public Iterator<FacesMessage> getMessages(String clientId)

Implements abstract jakarta.faces.context.FacesContext.getMessages.

The default behavior of this method is to call FacesContext#getMessages(String) on the wrapped FacesContext object.

Parameters

clientId:String

Doc from jakarta.faces.context.FacesContext.getMessages.

The client identifier for which messages are requested, or null for messages not associated with any client identifier

Returns:Iterator<FacesMessage>

Doc from jakarta.faces.context.FacesContext.getMessages.

Iterator over the FacesMessages.

Annotations

@Override

getNamingContainerSeparatorChar back to summary

getNamingContainerSeparatorChar	back to summary
public char getNamingContainerSeparatorChar() Overrides jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar. The default behavior of this method is to call `FacesContext#getNamingContainerSeparatorChar()` on the wrapped `FacesContext` object. Returns:char Doc from jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar. the separator char. Annotations @Override See Also `jakarta.faces.context.FacesContext#getNamingContainerSeparatorChar()`

public char getNamingContainerSeparatorChar()

Overrides jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar.

The default behavior of this method is to call FacesContext#getNamingContainerSeparatorChar() on the wrapped FacesContext object.

Returns:char

Doc from jakarta.faces.context.FacesContext.getNamingContainerSeparatorChar.

the separator char.

Annotations

@Override

getPartialViewContext back to summary

getPartialViewContext	back to summary
public PartialViewContext getPartialViewContext() Overrides jakarta.faces.context.FacesContext.getPartialViewContext. The default behavior of this method is to call `FacesContext#getPartialViewContext()` ()} on the wrapped `FacesContext` object. Returns:PartialViewContext Doc from jakarta.faces.context.FacesContext.getPartialViewContext. the instance of `PartialViewContext` for this request. Annotations @Override See Also `jakarta.faces.context.FacesContext#getPartialViewContext()`

public PartialViewContext getPartialViewContext()

Overrides jakarta.faces.context.FacesContext.getPartialViewContext.

The default behavior of this method is to call FacesContext#getPartialViewContext() ()} on the wrapped FacesContext object.

Returns:PartialViewContext

Doc from jakarta.faces.context.FacesContext.getPartialViewContext.

the instance of PartialViewContext for this request.

Annotations

@Override

getRenderKit back to summary

getRenderKit	back to summary
public RenderKit getRenderKit() Implements abstract jakarta.faces.context.FacesContext.getRenderKit. The default behavior of this method is to call `FacesContext#getRenderKit()` on the wrapped `FacesContext` object. Returns:RenderKit Doc from jakarta.faces.context.FacesContext.getRenderKit. instance of `RenderKit` associated with the `UIViewRoot`. Annotations @Override See Also `jakarta.faces.context.FacesContext#getRenderKit()`

public RenderKit getRenderKit()

Implements abstract jakarta.faces.context.FacesContext.getRenderKit.

The default behavior of this method is to call FacesContext#getRenderKit() on the wrapped FacesContext object.

Returns:RenderKit

Doc from jakarta.faces.context.FacesContext.getRenderKit.

instance of RenderKit associated with the UIViewRoot.

Annotations

@Override

getRenderResponse back to summary

getRenderResponse	back to summary
public boolean getRenderResponse() Implements abstract jakarta.faces.context.FacesContext.getRenderResponse. The default behavior of this method is to call `FacesContext#getRenderResponse()` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.getRenderResponse. flag indicating whether the `renderResponse()` has been called. Annotations @Override See Also `jakarta.faces.context.FacesContext#getRenderResponse()`

public boolean getRenderResponse()

Implements abstract jakarta.faces.context.FacesContext.getRenderResponse.

The default behavior of this method is to call FacesContext#getRenderResponse() on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.getRenderResponse.

flag indicating whether the renderResponse() has been called.

Annotations

@Override

getResourceLibraryContracts back to summary

getResourceLibraryContracts	back to summary
public List<String> getResourceLibraryContracts() Overrides jakarta.faces.context.FacesContext.getResourceLibraryContracts. The default behavior of this method is to call `FacesContext#getResourceLibraryContracts` on the wrapped `FacesContext` object. Returns:List<String> Doc from jakarta.faces.context.FacesContext.getResourceLibraryContracts. the list of resource library contracts. Annotations @Override See Also `jakarta.faces.context.FacesContext#getResourceLibraryContracts`

public List<String> getResourceLibraryContracts()

Overrides jakarta.faces.context.FacesContext.getResourceLibraryContracts.

The default behavior of this method is to call FacesContext#getResourceLibraryContracts on the wrapped FacesContext object.

Returns:List<String>

Doc from jakarta.faces.context.FacesContext.getResourceLibraryContracts.

the list of resource library contracts.

Annotations

@Override

getResponseComplete back to summary

getResponseComplete	back to summary
public boolean getResponseComplete() Implements abstract jakarta.faces.context.FacesContext.getResponseComplete. The default behavior of this method is to call `FacesContext#getResponseComplete()` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.getResponseComplete. the boolean indicating whether `responseComplete()` method has been called. Annotations @Override See Also `jakarta.faces.context.FacesContext#getResponseComplete()`

public boolean getResponseComplete()

Implements abstract jakarta.faces.context.FacesContext.getResponseComplete.

The default behavior of this method is to call FacesContext#getResponseComplete() on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.getResponseComplete.

the boolean indicating whether responseComplete() method has been called.

Annotations

@Override

getResponseStream back to summary

getResponseStream	back to summary
public ResponseStream getResponseStream() Implements abstract jakarta.faces.context.FacesContext.getResponseStream. The default behavior of this method is to call `FacesContext#getResponseStream()` on the wrapped `FacesContext` object. Returns:ResponseStream Doc from jakarta.faces.context.FacesContext.getResponseStream. `ResponseStream` instance. Annotations @Override See Also `jakarta.faces.context.FacesContext#getResponseStream()`

public ResponseStream getResponseStream()

Implements abstract jakarta.faces.context.FacesContext.getResponseStream.

The default behavior of this method is to call FacesContext#getResponseStream() on the wrapped FacesContext object.

Returns:ResponseStream

Doc from jakarta.faces.context.FacesContext.getResponseStream.

ResponseStream instance.

Annotations

@Override

getResponseWriter back to summary

getResponseWriter	back to summary
public ResponseWriter getResponseWriter() Implements abstract jakarta.faces.context.FacesContext.getResponseWriter. The default behavior of this method is to call `FacesContext#getResponseWriter()` on the wrapped `FacesContext` object. Returns:ResponseWriter Doc from jakarta.faces.context.FacesContext.getResponseWriter. `ResponseWriter` instance. Annotations @Override See Also `jakarta.faces.context.FacesContext#getResponseWriter()`

public ResponseWriter getResponseWriter()

Implements abstract jakarta.faces.context.FacesContext.getResponseWriter.

The default behavior of this method is to call FacesContext#getResponseWriter() on the wrapped FacesContext object.

Returns:ResponseWriter

Doc from jakarta.faces.context.FacesContext.getResponseWriter.

ResponseWriter instance.

Annotations

@Override

getViewRoot back to summary

getViewRoot	back to summary
public UIViewRoot getViewRoot() Implements abstract jakarta.faces.context.FacesContext.getViewRoot. The default behavior of this method is to call `FacesContext#getViewRoot()` on the wrapped `FacesContext` object. Returns:UIViewRoot Doc from jakarta.faces.context.FacesContext.getViewRoot. `UIViewRoot` instance. Annotations @Override See Also `jakarta.faces.context.FacesContext#getViewRoot()`

public UIViewRoot getViewRoot()

Implements abstract jakarta.faces.context.FacesContext.getViewRoot.

The default behavior of this method is to call FacesContext#getViewRoot() on the wrapped FacesContext object.

Returns:UIViewRoot

Doc from jakarta.faces.context.FacesContext.getViewRoot.

UIViewRoot instance.

Annotations

@Override

getWrapped	back to summary
public FacesContext getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. Doc from jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped. Returns:FacesContext the wrapped instance. Annotations @Override

getWrapped

back to summary

public FacesContext getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:FacesContext

the wrapped instance.

Annotations

@Override

isPostback back to summary

isPostback	back to summary
public boolean isPostback() Overrides jakarta.faces.context.FacesContext.isPostback. The default behavior of this method is to call `FacesContext#isPostback()` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.isPostback. the boolean indicating whether this request is a post one. Annotations @Override See Also `jakarta.faces.context.FacesContext#isPostback()`

public boolean isPostback()

Overrides jakarta.faces.context.FacesContext.isPostback.

The default behavior of this method is to call FacesContext#isPostback() on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isPostback.

the boolean indicating whether this request is a post one.

Annotations

@Override

isProcessingEvents back to summary

isProcessingEvents	back to summary
public boolean isProcessingEvents() Overrides jakarta.faces.context.FacesContext.isProcessingEvents. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isProcessingEvents()` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.isProcessingEvents. `true` if events should be published, otherwise `false` Annotations @Override See Also `FacesContext#isProcessingEvents()`

public boolean isProcessingEvents()

Overrides jakarta.faces.context.FacesContext.isProcessingEvents.

The default behavior of this method is to call jakarta.faces.context.FacesContext#isProcessingEvents() on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isProcessingEvents.

true if events should be published, otherwise false

Annotations

@Override

See Also

FacesContext#isProcessingEvents()

isProjectStage back to summary

isProjectStage	back to summary
public boolean isProjectStage(ProjectStage stage) Overrides jakarta.faces.context.FacesContext.isProjectStage. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage)` on the wrapped `FacesContext` object. Parameters stage:ProjectStage Doc from jakarta.faces.context.FacesContext.isProjectStage. the `ProjectStage` to check Returns:boolean Doc from jakarta.faces.context.FacesContext.isProjectStage. boolean indicating whether the application has the same stage. Annotations @Override See Also `FacesContext#isProjectStage(jakarta.faces.application.ProjectStage)`

public boolean isProjectStage(ProjectStage stage)

Overrides jakarta.faces.context.FacesContext.isProjectStage.

The default behavior of this method is to call jakarta.faces.context.FacesContext#isProjectStage(jakarta.faces.application.ProjectStage) on the wrapped FacesContext object.

Parameters

stage:ProjectStage

Doc from jakarta.faces.context.FacesContext.isProjectStage.

the ProjectStage to check

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isProjectStage.

boolean indicating whether the application has the same stage.

Annotations

@Override

isReleased back to summary

isReleased	back to summary
public boolean isReleased() Overrides jakarta.faces.context.FacesContext.isReleased. The default behavior of this method is to call `FacesContext#isReleased` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.isReleased. `true` if the resources have been released. Annotations @Override Since 2.1 See Also `jakarta.faces.context.FacesContext#isReleased`

public boolean isReleased()

Overrides jakarta.faces.context.FacesContext.isReleased.

The default behavior of this method is to call FacesContext#isReleased on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isReleased.

true if the resources have been released.

Annotations

@Override

Since

2.1

isValidationFailed back to summary

isValidationFailed	back to summary
public boolean isValidationFailed() Overrides jakarta.faces.context.FacesContext.isValidationFailed. The default behavior of this method is to call `jakarta.faces.context.FacesContext#isValidationFailed` on the wrapped `FacesContext` object. Returns:boolean Doc from jakarta.faces.context.FacesContext.isValidationFailed. boolean indicating if the `validationFailed()` method has been called for the current request Annotations @Override See Also `FacesContext#isValidationFailed`

public boolean isValidationFailed()

Overrides jakarta.faces.context.FacesContext.isValidationFailed.

The default behavior of this method is to call jakarta.faces.context.FacesContext#isValidationFailed on the wrapped FacesContext object.

Returns:boolean

Doc from jakarta.faces.context.FacesContext.isValidationFailed.

boolean indicating if the validationFailed() method has been called for the current request

Annotations

@Override

See Also

FacesContext#isValidationFailed

release back to summary

release	back to summary
public void release() Implements abstract jakarta.faces.context.FacesContext.release. The default behavior of this method is to call `FacesContext#release()` on the wrapped `FacesContext` object. Annotations @Override See Also `jakarta.faces.context.FacesContext#release()`

public void release()

Implements abstract jakarta.faces.context.FacesContext.release.

The default behavior of this method is to call FacesContext#release() on the wrapped FacesContext object.

Annotations

@Override

renderResponse back to summary

renderResponse	back to summary
public void renderResponse() Implements abstract jakarta.faces.context.FacesContext.renderResponse. The default behavior of this method is to call `FacesContext#renderResponse()` on the wrapped `FacesContext` object. Annotations @Override See Also `jakarta.faces.context.FacesContext#renderResponse()`

public void renderResponse()

Implements abstract jakarta.faces.context.FacesContext.renderResponse.

The default behavior of this method is to call FacesContext#renderResponse() on the wrapped FacesContext object.

Annotations

@Override

responseComplete back to summary

responseComplete	back to summary
public void responseComplete() Implements abstract jakarta.faces.context.FacesContext.responseComplete. The default behavior of this method is to call `FacesContext#responseComplete()` on the wrapped `FacesContext` object. Annotations @Override See Also `jakarta.faces.context.FacesContext#responseComplete()`

public void responseComplete()

Implements abstract jakarta.faces.context.FacesContext.responseComplete.

The default behavior of this method is to call FacesContext#responseComplete() on the wrapped FacesContext object.

Annotations

@Override

setCurrentPhaseId back to summary

setCurrentPhaseId	back to summary
public void setCurrentPhaseId(PhaseId currentPhaseId) Overrides jakarta.faces.context.FacesContext.setCurrentPhaseId. The default behavior of this method is to call `FacesContext#setCurrentPhaseId(PhaseId)` on the wrapped `FacesContext` object. Parameters currentPhaseId:PhaseId Doc from jakarta.faces.context.FacesContext.setCurrentPhaseId. The `jakarta.faces.event.PhaseId` for the current phase. Annotations @Override See Also `jakarta.faces.context.FacesContext#setCurrentPhaseId(PhaseId)`

public void setCurrentPhaseId(PhaseId currentPhaseId)

Overrides jakarta.faces.context.FacesContext.setCurrentPhaseId.

The default behavior of this method is to call FacesContext#setCurrentPhaseId(PhaseId) on the wrapped FacesContext object.

Parameters

currentPhaseId:PhaseId

Doc from jakarta.faces.context.FacesContext.setCurrentPhaseId.

The jakarta.faces.event.PhaseId for the current phase.

Annotations

@Override

setExceptionHandler back to summary

setExceptionHandler	back to summary
public void setExceptionHandler(ExceptionHandler exceptionHandler) Overrides jakarta.faces.context.FacesContext.setExceptionHandler. The default behavior of this method is to call `FacesContext#setExceptionHandler(ExceptionHandler)` on the wrapped `FacesContext` object. Parameters exceptionHandler:ExceptionHandler Doc from jakarta.faces.context.FacesContext.setExceptionHandler. the `ExceptionHandler` for this request. Annotations @Override See Also `jakarta.faces.context.FacesContext#setExceptionHandler(ExceptionHandler)`

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Overrides jakarta.faces.context.FacesContext.setExceptionHandler.

The default behavior of this method is to call FacesContext#setExceptionHandler(ExceptionHandler) on the wrapped FacesContext object.

Parameters

exceptionHandler:ExceptionHandler

Doc from jakarta.faces.context.FacesContext.setExceptionHandler.

the ExceptionHandler for this request.

Annotations

@Override

setProcessingEvents back to summary

setProcessingEvents	back to summary
public void setProcessingEvents(boolean processingEvents) Overrides jakarta.faces.context.FacesContext.setProcessingEvents. The default behavior of this method is to call `FacesContext#setProcessingEvents(boolean)` on the wrapped `FacesContext` object. Parameters processingEvents:boolean Doc from jakarta.faces.context.FacesContext.setProcessingEvents. flag indicating events should be processed or not Annotations @Override See Also `jakarta.faces.context.FacesContext#setProcessingEvents(boolean)`

public void setProcessingEvents(boolean processingEvents)

Overrides jakarta.faces.context.FacesContext.setProcessingEvents.

The default behavior of this method is to call FacesContext#setProcessingEvents(boolean) on the wrapped FacesContext object.

Parameters

processingEvents:boolean

Doc from jakarta.faces.context.FacesContext.setProcessingEvents.

flag indicating events should be processed or not

Annotations

@Override

setResourceLibraryContracts back to summary

setResourceLibraryContracts	back to summary
public void setResourceLibraryContracts(List<String> contracts) Overrides jakarta.faces.context.FacesContext.setResourceLibraryContracts. The default behavior of this method is to call `FacesContext#setResourceLibraryContracts` on the wrapped `FacesContext` object. Parameters contracts:List<String> Doc from jakarta.faces.context.FacesContext.setResourceLibraryContracts. The new contracts to be returned, as an immutable `List`. from a subsequent call to `getResourceLibraryContracts`. Annotations @Override See Also `jakarta.faces.context.FacesContext#setResourceLibraryContracts`

public void setResourceLibraryContracts(List<String> contracts)

Overrides jakarta.faces.context.FacesContext.setResourceLibraryContracts.

The default behavior of this method is to call FacesContext#setResourceLibraryContracts on the wrapped FacesContext object.

Parameters

contracts:List<String>

Doc from jakarta.faces.context.FacesContext.setResourceLibraryContracts.

The new contracts to be returned, as an immutable List. from a subsequent call to getResourceLibraryContracts.

Annotations

@Override

setResponseStream back to summary

setResponseStream	back to summary
public void setResponseStream(ResponseStream responseStream) Implements abstract jakarta.faces.context.FacesContext.setResponseStream. The default behavior of this method is to call `FacesContext#setResponseStream(ResponseStream)` on the wrapped `FacesContext` object. Parameters responseStream:ResponseStream Doc from jakarta.faces.context.FacesContext.setResponseStream. The new ResponseStream for this response Annotations @Override See Also `jakarta.faces.context.FacesContext#setResponseStream(ResponseStream)`

public void setResponseStream(ResponseStream responseStream)

Implements abstract jakarta.faces.context.FacesContext.setResponseStream.

The default behavior of this method is to call FacesContext#setResponseStream(ResponseStream) on the wrapped FacesContext object.

Parameters

responseStream:ResponseStream

Doc from jakarta.faces.context.FacesContext.setResponseStream.

The new ResponseStream for this response

Annotations

@Override

setResponseWriter back to summary

setResponseWriter	back to summary
public void setResponseWriter(ResponseWriter responseWriter) Implements abstract jakarta.faces.context.FacesContext.setResponseWriter. The default behavior of this method is to call `FacesContext#setResponseWriter(ResponseWriter)` on the wrapped `FacesContext` object. Parameters responseWriter:ResponseWriter Doc from jakarta.faces.context.FacesContext.setResponseWriter. The new ResponseWriter for this response Annotations @Override See Also `jakarta.faces.context.FacesContext#setResponseWriter(ResponseWriter)`

public void setResponseWriter(ResponseWriter responseWriter)

Implements abstract jakarta.faces.context.FacesContext.setResponseWriter.

The default behavior of this method is to call FacesContext#setResponseWriter(ResponseWriter) on the wrapped FacesContext object.

Parameters

responseWriter:ResponseWriter

Doc from jakarta.faces.context.FacesContext.setResponseWriter.

The new ResponseWriter for this response

Annotations

@Override

setViewRoot back to summary

setViewRoot	back to summary
public void setViewRoot(UIViewRoot root) Implements abstract jakarta.faces.context.FacesContext.setViewRoot. The default behavior of this method is to call `FacesContext#setViewRoot(UIViewRoot)` on the wrapped `FacesContext` object. Parameters root:UIViewRoot Doc from jakarta.faces.context.FacesContext.setViewRoot. The new component `UIViewRoot` component Annotations @Override See Also `jakarta.faces.context.FacesContext#setViewRoot(UIViewRoot)`

public void setViewRoot(UIViewRoot root)

Implements abstract jakarta.faces.context.FacesContext.setViewRoot.

The default behavior of this method is to call FacesContext#setViewRoot(UIViewRoot) on the wrapped FacesContext object.

Parameters

root:UIViewRoot

Doc from jakarta.faces.context.FacesContext.setViewRoot.

The new component UIViewRoot component

Annotations

@Override

validationFailed back to summary

validationFailed	back to summary
public void validationFailed() Overrides jakarta.faces.context.FacesContext.validationFailed. The default behavior of this method is to call `jakarta.faces.context.FacesContext#validationFailed()` on the wrapped `FacesContext` object. Annotations @Override See Also `FacesContext#validationFailed()`

public void validationFailed()

Overrides jakarta.faces.context.FacesContext.validationFailed.

The default behavior of this method is to call jakarta.faces.context.FacesContext#validationFailed() on the wrapped FacesContext object.

Annotations

@Override

See Also

FacesContext#validationFailed()

public abstract Class FacesContextWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail