Jakarta EE 11.0.0 · jakarta.faces.event.ExceptionQueuedEventContext

Field Summary

Modifier and Type	Field and Description
private Map<Object, Object>	attributes
private final UIComponent	component
private final FacesContext	context
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.
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.
private List<SystemEventListener>	listener
private final PhaseId	phaseId
private final Throwable	thrown

Constructor Summary

Access	Constructor and Description
public	ExceptionQueuedEventContext(FacesContext `FacesContext` for the current request context, Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance. thrown) Instantiate a new `ExceptionQueuedEventContext` that indicates the argument `Throwable` just occurred.
public	ExceptionQueuedEventContext(FacesContext `FacesContext` for the current request context, Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance. thrown, UIComponent the `UIComponent` instance to which this `ExceptionQueuedEventContext` pertains component) Instantiate a new `ExceptionQueuedEventContext` that indicates the argument `Throwable` just occurred, relevant to the argument `component`.
public	ExceptionQueuedEventContext(FacesContext `FacesContext` for the current request context, Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance. thrown, UIComponent the `UIComponent` that is relevant to the context. component, PhaseId the `PhaseId` at the time this `ExeceptionEventContext` is created. 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 and Description
public Map<Object, Object>	Returns: attributes related to this context getAttributes() A `Map` of attributes relevant to the context of this `ExceptionQueuedEvent`.
public UIComponent	Returns: the component getComponent() Return the `UIComponent` which was being processed when the exception was thrown.
public FacesContext	Returns: the `FacesContext` used to create this `ExceptionQueuedEventContext` instance. getContext() The `FacesContext` for this request.
public Throwable	Returns: the exception getException() Return the `exception` property.
public List<SystemEventListener>	getListenersForEventClass(Class<? extends SystemEvent> the class for which listeners are to be returned facesEventClass) Implements jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass. Return a `List` that contains a single entry, the `jakarta.faces.context.ExceptionHandler` for the current request.
public PhaseId	Returns: the phase id getPhaseId() Return the `PhaseId` which was being processed when the exception was thrown.
public boolean	Returns: `true` if the exception occurred during the `after phase` processing for a particular lifecycle phase inAfterPhase()
public boolean	Returns: `true` if the exception occurred during the `before phase` processing for a particular lifecycle phase inBeforePhase()
private boolean	isAttributeDefined(String key)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attributes	back to summary
private Map<Object, Object> attributes

component	back to summary
private final UIComponent component

context	back to summary
private final FacesContext context

IN_AFTER_PHASE_KEY	back to summary
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.

IN_BEFORE_PHASE_KEY	back to summary
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.

listener	back to summary
private List<SystemEventListener> listener

phaseId	back to summary
private final PhaseId phaseId

thrown	back to summary
private final Throwable thrown

Constructor Detail

ExceptionQueuedEventContext back to summary

ExceptionQueuedEventContext	back to summary
public ExceptionQueuedEventContext(FacesContext context, Throwable thrown) Instantiate a new `ExceptionQueuedEventContext` that indicates the argument `Throwable` just occurred. Parameters context:FacesContext `FacesContext` for the current request thrown:Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance.

public ExceptionQueuedEventContext(FacesContext context, Throwable thrown)

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

Parameters

context:FacesContext: FacesContext for the current request
thrown:Throwable: the Throwable that is the context for this ExceptionQueuedEventContext instance.

ExceptionQueuedEventContext back to summary

ExceptionQueuedEventContext	back to summary
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 `FacesContext` for the current request thrown:Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance. component:UIComponent the `UIComponent` instance to which this `ExceptionQueuedEventContext` pertains

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: FacesContext for the current request
thrown:Throwable: the Throwable that is the context for this ExceptionQueuedEventContext instance.
component:UIComponent: the UIComponent instance to which this ExceptionQueuedEventContext pertains

ExceptionQueuedEventContext back to summary

ExceptionQueuedEventContext	back to summary
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 `FacesContext` for the current request thrown:Throwable the `Throwable` that is the context for this `ExceptionQueuedEventContext` instance. component:UIComponent the `UIComponent` that is relevant to the context. phaseId:PhaseId the `PhaseId` at the time this `ExeceptionEventContext` is created.

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: FacesContext for the current request
thrown:Throwable: the Throwable that is the context for this ExceptionQueuedEventContext instance.
component:UIComponent: the UIComponent that is relevant to the context.
phaseId:PhaseId: the PhaseId at the time this ExeceptionEventContext is created.

Method Detail

getAttributes back to summary

getAttributes	back to summary
public Map<Object, Object> getAttributes() A `Map` of attributes relevant to the context of this `ExceptionQueuedEvent`. Returns:Map<Object, Object> attributes related to this context

public Map<Object, Object> getAttributes()

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

Returns:Map<Object, Object>: attributes related to this context

getComponent back to summary

getComponent	back to summary
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:UIComponent the component

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:UIComponent: the component

getContext back to summary

getContext	back to summary
public FacesContext getContext() The `FacesContext` for this request. Returns:FacesContext the `FacesContext` used to create this `ExceptionQueuedEventContext` instance.

public FacesContext getContext()

The FacesContext for this request.

Returns:FacesContext: the FacesContext used to create this ExceptionQueuedEventContext instance.

getException back to summary

getException	back to summary
public Throwable getException() Return the `exception` property. Returns:Throwable the exception

public Throwable getException()

Return the exception property.

Returns:Throwable: the exception

getListenersForEventClass back to summary

getListenersForEventClass	back to summary
public List<SystemEventListener> getListenersForEventClass(Class<? extends SystemEvent> facesEventClass) Implements jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass. Return a `List` that contains a single entry, the `jakarta.faces.context.ExceptionHandler` for the current request. Parameters facesEventClass:Class<? extends SystemEvent> Doc from jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass. the class for which listeners are to be returned Returns:List<SystemEventListener> Doc from jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass. the listeners for the argument class Annotations @Override

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

Implements jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass.

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

Parameters

facesEventClass:Class<? extends SystemEvent>

Doc from jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass.

the class for which listeners are to be returned

Returns:List<SystemEventListener>

Doc from jakarta.faces.event.SystemEventListenerHolder.getListenersForEventClass.

the listeners for the argument class

Annotations

@Override

getPhaseId back to summary

getPhaseId	back to summary
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:PhaseId the phase id

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:PhaseId: the phase id

inAfterPhase	back to summary
public boolean inAfterPhase() Returns:boolean `true` if the exception occurred during the `after phase` processing for a particular lifecycle phase

inBeforePhase	back to summary
public boolean inBeforePhase() Returns:boolean `true` if the exception occurred during the `before phase` processing for a particular lifecycle phase

isAttributeDefined	back to summary
private boolean isAttributeDefined(String key)

public Class ExceptionQueuedEventContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail