Module jakarta.faces

Package jakarta.faces.event

Class ExceptionQueuedEventContext

java.lang.Object

jakarta.faces.event.ExceptionQueuedEventContext

All Implemented Interfaces:

SystemEventListenerHolder

public class ExceptionQueuedEventContext
extends Object
implements SystemEventListenerHolder

This helper class provides context to the ExceptionQueuedEvent regarding the state of the system at the point in time when the ExceptionQueuedEvent occurs and links the ExceptionQueuedEvent to the ExceptionHandler by virtue of implementing SystemEventListener.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IN_AFTER_PHASE_KEY	The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “after phase” part of the current lifecycle phase.
static final String	IN_BEFORE_PHASE_KEY	The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “before phase” part of the current lifecycle phase.

Constructor Summary

Constructors

Constructor	Description
ExceptionQueuedEventContext(FacesContext context, Throwable thrown)	Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred.
ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)	Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component.
ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)	Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component, during the lifecycle phase phaseId.

Method Summary

Modifier and Type	Method	Description
Map<Object,Object>	getAttributes()	A Map of attributes relevant to the context of this ExceptionQueuedEvent.
UIComponent	getComponent()	Return the UIComponent which was being processed when the exception was thrown.
FacesContext	getContext()	The FacesContext for this request.
Throwable	getException()	Return the exception property.
List<SystemEventListener>	getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)	Return a List that contains a single entry, the ExceptionHandler for the current request.
PhaseId	getPhaseId()	Return the PhaseId which was being processed when the exception was thrown.
boolean	inAfterPhase()
boolean	inBeforePhase()

Methods inherited from class java.lang.Object

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

Field Details

IN_BEFORE_PHASE_KEY

public static final String IN_BEFORE_PHASE_KEY

The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “before phase” part of the current lifecycle phase.

IN_AFTER_PHASE_KEY

public static final String IN_AFTER_PHASE_KEY

The presence of an entry under this key in the Map returned from getAttributes() indicates the event occurred during the “after phase” part of the current lifecycle phase.

Constructor Details

ExceptionQueuedEventContext

public ExceptionQueuedEventContext(FacesContext context,
 Throwable thrown)

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred.

Parameters:

context - FacesContext for the current request

thrown - the Throwable that is the context for this ExceptionQueuedEventContext instance.

ExceptionQueuedEventContext

public ExceptionQueuedEventContext(FacesContext context,
 Throwable thrown,
 UIComponent component)

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component.

Parameters:

context - FacesContext for the current request

thrown - the Throwable that is the context for this ExceptionQueuedEventContext instance.

component - the UIComponent instance to which this ExceptionQueuedEventContext pertains

ExceptionQueuedEventContext

public ExceptionQueuedEventContext(FacesContext context,
 Throwable thrown,
 UIComponent component,
 PhaseId phaseId)

Instantiate a new ExceptionQueuedEventContext that indicates the argument Throwable just occurred, relevant to the argument component, during the lifecycle phase phaseId.

Parameters:

context - FacesContext for the current request

thrown - the Throwable that is the context for this ExceptionQueuedEventContext instance.

component - the UIComponent that is relevant to the context.

phaseId - the PhaseId at the time this ExeceptionEventContext is created.

Method Details

getContext

public FacesContext getContext()

The FacesContext for this request.

Returns:

the FacesContext used to create this ExceptionQueuedEventContext instance.

getException

public Throwable getException()

Return the exception property.

Returns:

the exception

getComponent

public UIComponent getComponent()

Return the UIComponent which was being processed when the exception was thrown. If none or not available, this will be null.

Returns:

the component

getPhaseId

public PhaseId getPhaseId()

Return the PhaseId which was being processed when the exception was thrown. If none or not available, this will be null.

Returns:

the phase id

inBeforePhase

public boolean inBeforePhase()

Returns:

true if the exception occurred during the before phase processing for a particular lifecycle phase

inAfterPhase

public boolean inAfterPhase()

Returns:

true if the exception occurred during the after phase processing for a particular lifecycle phase

getAttributes

public Map<Object,Object> getAttributes()

A Map of attributes relevant to the context of this ExceptionQueuedEvent.

Returns:

attributes related to this context

getListenersForEventClass

public List<SystemEventListener> getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)

Return a List that contains a single entry, the ExceptionHandler for the current request.

Specified by:

getListenersForEventClass in interface SystemEventListenerHolder

Parameters:

facesEventClass - the class for which listeners are to be returned

Returns:

the listeners for the argument class