Top Description Fields Constructors Methods
jakarta.faces.context

public abstract Class FacesContextWrapper

extends FacesContext
implements FacesWrapper<FacesContext>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Known Direct Subclasses
jakarta.faces.component.UIViewAction.InstrumentedFacesContext
Imports
java.util.Iterator, .List, .Map, jakarta.el.ELContext, jakarta.faces.FacesWrapper, jakarta.faces.application.Application, .FacesMessage, .ProjectStage, jakarta.faces.component.UIViewRoot, jakarta.faces.event.PhaseId, jakarta.faces.lifecycle.Lifecycle, jakarta.faces.render.RenderKit

Provides a simple implementation of FacesContext that can be subclassed by developers wishing to provide specialized behavior to an existing FacesContext instance. The default implementation of all methods is to call through to the wrapped FacesContext instance.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.0

Field Summary

Modifier and TypeField and Description
private FacesContext
wrapped

Constructor Summary

AccessConstructor 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.

Method Summary

Modifier and TypeMethod 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.

Inherited from jakarta.faces.context.FacesContext:
getCurrentInstancesetCurrentInstance