public abstract Class NoOpFacesContext

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

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

Append a jakarta.faces.application.FacesMessage to the set of messages associated with the specified client identifier, if clientId is not null. If clientId is null, this jakarta.faces.application.FacesMessage is assumed to not be associated with any specific component instance.

Parameters

clientId:String

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

message:FacesMessage

The message to be appended

Annotations

@Override

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

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

Return an Iterator over the client identifiers for which at least one jakarta.faces.application.FacesMessage has been queued. If there are no such client identifiers, an empty Iterator is returned. If any messages have been queued that were not associated with any specific client identifier, a null value will be included in the iterated values. The elements in the Iterator must be returned in the order in which they were added with addMessage.

Returns:Iterator<String>

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

Annotations

@Override

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

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

Return the Lifecycle instance for this FacesContext instance.

Returns:Lifecycle

instance of Lifecycle

Annotations

@Override

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

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

Return the maximum severity level recorded on any jakarta.faces.application.FacesMessages that has been queued, whether or not they are associated with any specific jakarta.faces.component.UIComponent. If no such messages have been queued, return null.

Returns:FacesMessage.Severity

the maximum severity level.

Annotations

@Override

Overrides jakarta.faces.context.FacesContext.getMessageList.

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

Like getMessages, but returns a List<FacesMessage>, enabling use from Jakarta Expression Language expressions.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

Returns:List<FacesMessage>

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

Annotations

@Override

Overrides jakarta.faces.context.FacesContext.getMessageList.

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

Like getMessages(java.lang.String), but returns a List<FacesMessage> of messages for the component with client id matching argument clientId.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

Parameters

clientId:String

the client id of a component.

Returns:List<FacesMessage>

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

Annotations

@Override

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

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

Return an Iterator over the jakarta.faces.application.FacesMessages that have been queued, whether or not they are associated with any specific client identifier. If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to addMessage.

Returns:Iterator<FacesMessage>

Iterator over the FacesMessages that have been queued.

Annotations

@Override

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

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

Return an Iterator over the jakarta.faces.application.FacesMessages that have been queued that are associated with the specified client identifier (if clientId is not null), or over the jakarta.faces.application.FacesMessages that have been queued that are not associated with any specific client identifier (if clientId is null). If no such messages have been queued, return an empty Iterator. The elements of the Iterator must be returned in the order in which they were added with calls to addMessage.

Parameters

clientId:String

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

Returns:Iterator<FacesMessage>

Iterator over the FacesMessages.

Annotations

@Override

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

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

Return the RenderKit instance for the render kit identifier specified on our UIViewRoot, if there is one. If there is no current UIViewRoot, if the UIViewRoot does not have a specified renderKitId, or if there is no RenderKit for the specified identifier, return null instead.

Returns:RenderKit

instance of RenderKit associated with the UIViewRoot.

Annotations

@Override

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

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

Return true if the renderResponse() method has been called for the current request.

Returns:boolean

flag indicating whether the renderResponse() has been called.

Annotations

@Override

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

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

Return true if the responseComplete() method has been called for the current request.

Returns:boolean

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

Annotations

@Override

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

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

Return the ResponseStream to which components should direct their binary output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both.

Returns:ResponseStream

ResponseStream instance.

Annotations

@Override

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

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

Return the ResponseWriter to which components should direct their character-based output. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both.

Returns:ResponseWriter

ResponseWriter instance.

Annotations

@Override

Overrides jakarta.faces.context.FacesContext.isValidationFailed.

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

Return true if the validationFailed() method has been called for the current request.

Returns:boolean

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

Annotations

@Override

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

Doc from jakarta.faces.context.FacesContext.renderResponse.

Signal the Jakarta Faces implementation that, as soon as the current phase of the request processing lifecycle has been completed, control should be passed to the Render Response phase, bypassing any phases that have not been executed yet.

Annotations

@Override

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

Doc from jakarta.faces.context.FacesContext.responseComplete.

Signal the Jakarta Faces implementation that the HTTP response for this request has already been generated (such as an HTTP redirect), and that the request processing lifecycle should be terminated as soon as the current phase is completed.

Annotations

@Override

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

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

Set the ResponseStream to which components should direct their binary output.

Parameters

responseStream:ResponseStream

The new ResponseStream for this response

Annotations

@Override

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

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

Set the ResponseWriter to which components should direct their character-based output.

Parameters

responseWriter:ResponseWriter

The new ResponseWriter for this response

Annotations

@Override

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

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

Set the root component that is associated with this request.

This method can be called by the application handler (or a class that the handler calls), during the Invoke Application phase of the request processing lifecycle and during the Restore View phase of the request processing lifecycle (especially when a new root component is created). In the present version of the specification, implementations are not required to enforce this restriction, though a future version of the specification may require enforcement.

If the current UIViewRoot is non-null, and calling equals() on the argument root, passing the current UIViewRoot returns false, the clear method must be called on the Map returned from UIViewRoot#getViewMap.

Parameters

root:UIViewRoot

The new component UIViewRoot component

Annotations

@Override

Overrides jakarta.faces.context.FacesContext.validationFailed.

Doc from jakarta.faces.context.FacesContext.validationFailed.

Sets a flag which indicates that a conversion or validation error occurred while processing the inputs. Inputs consist of either page parameters or form bindings. This flag can be read using isValidationFailed.

Annotations

@Override