- java.lang.Object
-
- javax.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 theExceptionQueuedEvent
occurs and links theExceptionQueuedEvent
to theExceptionHandler
by virtue of implementingSystemEventListener
.- Since:
- 2.0
-
-
Field Summary
Fields Modifier and Type Field and Description static String
IN_AFTER_PHASE_KEY
The presence of an entry under this key in the
Map
returned fromgetAttributes()
indicates the event occurred during the “after phase” part of the current lifecycle phase.static String
IN_BEFORE_PHASE_KEY
The presence of an entry under this key in the
Map
returned fromgetAttributes()
indicates the event occurred during the “before phase” part of the current lifecycle phase.
-
Constructor Summary
Constructors Constructor and Description ExceptionQueuedEventContext(FacesContext context, Throwable thrown)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred.ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
.ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
, during the lifecycle phasephaseId
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description Map<Object,Object>
getAttributes()
A
Map
of attributes relevant to the context of thisExceptionQueuedEvent
.UIComponent
getComponent()
Return the
UIComponent
which was being processed when the exception was thrown.FacesContext
getContext()
Throwable
getException()
Return the
exception
property.List<SystemEventListener>
getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)
Return a
List
that contains a single entry, theExceptionHandler
for the current request.PhaseId
getPhaseId()
Return the
PhaseId
which was being processed when the exception was thrown.boolean
inAfterPhase()
boolean
inBeforePhase()
-
-
-
Field Detail
-
IN_BEFORE_PHASE_KEY
public static final String IN_BEFORE_PHASE_KEY
The presence of an entry under this key in the
Map
returned fromgetAttributes()
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 fromgetAttributes()
indicates the event occurred during the “after phase” part of the current lifecycle phase.
-
-
Constructor Detail
-
ExceptionQueuedEventContext
public ExceptionQueuedEventContext(FacesContext context, Throwable thrown)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred.- Parameters:
context
-FacesContext
for the current requestthrown
- theThrowable
that is the context for thisExceptionQueuedEventContext
instance.
-
ExceptionQueuedEventContext
public ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
.- Parameters:
context
-FacesContext
for the current requestthrown
- theThrowable
that is the context for thisExceptionQueuedEventContext
instance.component
- theUIComponent
instance to which thisExceptionQueuedEventContext
pertains
-
ExceptionQueuedEventContext
public ExceptionQueuedEventContext(FacesContext context, Throwable thrown, UIComponent component, PhaseId phaseId)
Instantiate a new
ExceptionQueuedEventContext
that indicates the argumentThrowable
just occurred, relevant to the argumentcomponent
, during the lifecycle phasephaseId
.- Parameters:
context
-FacesContext
for the current requestthrown
- theThrowable
that is the context for thisExceptionQueuedEventContext
instance.component
- theUIComponent
that is relevant to the context.phaseId
- thePhaseId
at the time thisExeceptionEventContext
is created.
-
-
Method Detail
-
getContext
public FacesContext getContext()
- Returns:
- the
FacesContext
used to create thisExceptionQueuedEventContext
instance.
-
getException
public Throwable getException()
Return the
exception
property.
-
getComponent
public UIComponent getComponent()
Return the
UIComponent
which was being processed when the exception was thrown. If none or not available, this will benull
.
-
getPhaseId
public PhaseId getPhaseId()
Return the
PhaseId
which was being processed when the exception was thrown. If none or not available, this will benull
.
-
inBeforePhase
public boolean inBeforePhase()
- Returns:
true
if the exception occurred during thebefore phase
processing for a particular lifecycle phase
-
inAfterPhase
public boolean inAfterPhase()
- Returns:
true
if the exception occurred during theafter phase
processing for a particular lifecycle phase
-
getAttributes
public Map<Object,Object> getAttributes()
A
Map
of attributes relevant to the context of thisExceptionQueuedEvent
.
-
getListenersForEventClass
public List<SystemEventListener> getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)
Return a
List
that contains a single entry, theExceptionHandler
for the current request.- Specified by:
getListenersForEventClass
in interfaceSystemEventListenerHolder
-
-
Kan deze pagina van de Infobrol-website niet weergeven
Type fout (18-01)
ID de navigation incorrect : 95025Probeer het over een paar minuten opnieuw…
Keer terug naar de startpagina
Steph