Module jakarta.faces

Package com.sun.faces.lifecycle

Class Phase

java.lang.Object

com.sun.faces.lifecycle.Phase

Direct Known Subclasses:

ApplyRequestValuesPhase, InvokeApplicationPhase, ProcessValidationsPhase, RenderResponsePhase, RestoreViewPhase, UpdateModelValuesPhase

public abstract class Phase
extends Object

A Phase is a single step in the processing of a Jakarta Faces request throughout its entire Lifecycle. Each Phase performs the required transitions on the state information in the FacesContext associated with this request.

Constructor Summary

Constructors

Constructor	Description
Phase()

Method Summary

Modifier and Type	Method	Description
void	doPhase(FacesContext context, Lifecycle lifecycle, ListIterator<PhaseListener> listeners)	Performs PhaseListener processing and invokes the execute method of the Phase.
abstract void	execute(FacesContext context)	Perform all state transitions required by the current phase of the request processing Lifecycle for a particular request.
abstract PhaseId	getId()
protected void	handleAfterPhase(FacesContext context, ListIterator<PhaseListener> listenersIterator, PhaseEvent event)	Handle afterPhase PhaseListener events.
protected void	handleBeforePhase(FacesContext context, ListIterator<PhaseListener> listenersIterator, PhaseEvent event)	Handle beforePhase PhaseListener events.
protected void	queueException(FacesContext ctx, Throwable t)
protected void	queueException(FacesContext ctx, Throwable t, String booleanKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Phase

public Phase()

Method Details

doPhase

public void doPhase(FacesContext context,
 Lifecycle lifecycle,
 ListIterator<PhaseListener> listeners)

Performs PhaseListener processing and invokes the execute method of the Phase.

Parameters:

context - the FacesContext for the current request

lifecycle - the lifecycle for this request

execute

public abstract void execute(FacesContext context)
                      throws FacesException

Perform all state transitions required by the current phase of the request processing Lifecycle for a particular request.

Parameters:

context - FacesContext for the current request being processed

Throws:

FacesException - if a processing error occurred while executing this phase

getId

public abstract PhaseId getId()

Returns:

the current Lifecycle Phase identifier.

queueException

protected void queueException(FacesContext ctx,
 Throwable t)

queueException

protected void queueException(FacesContext ctx,
 Throwable t,
 String booleanKey)

handleAfterPhase

protected void handleAfterPhase(FacesContext context,
 ListIterator<PhaseListener> listenersIterator,
 PhaseEvent event)

Handle afterPhase PhaseListener events.

Parameters:

context - the FacesContext for the current request

listenersIterator - a ListIterator for the PhaseListeners that need to be invoked

event - the event to pass to each of the invoked listeners

handleBeforePhase

protected void handleBeforePhase(FacesContext context,
 ListIterator<PhaseListener> listenersIterator,
 PhaseEvent event)

Handle beforePhase PhaseListener events.

Parameters:

context - the FacesContext for the current request

listenersIterator - a ListIterator for the PhaseListeners that need to be invoked

event - the event to pass to each of the invoked listeners