Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.faces.event
Class ExceptionQueuedEventContext

    java.lang.Object
      javax.faces.event.ExceptionQueuedEventContext

All Implemented Interfaces:
  SystemEventListenerHolder

    public class ExceptionQueuedEventContext

extends java.lang.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
`static java.lang.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 java.lang.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
`ExceptionQueuedEventContext(FacesContext context, java.lang.Throwable thrown)` Instantiate a new `ExceptionQueuedEventContext` that indicates the argument `Throwable` just occurred.
`ExceptionQueuedEventContext(FacesContext context, java.lang.Throwable thrown, UIComponent component)` Instantiate a new `ExceptionQueuedEventContext` that indicates the argument `Throwable` just occurred, relevant to the argument `component`.
`ExceptionQueuedEventContext(FacesContext context, java.lang.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
`java.util.Map<java.lang.Object,java.lang.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()`
`java.lang.Throwable` | `getException()` Return the `exception` property.
`java.util.List<SystemEventListener>` | `getListenersForEventClass(java.lang.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 Detail

### IN_BEFORE_PHASE_KEY

    public static final java.lang.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 java.lang.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 Detail

### ExceptionQueuedEventContext

    public ExceptionQueuedEventContext(FacesContext context,
                                       java.lang.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,
                                       java.lang.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,
                                       java.lang.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 Detail

### getContext

    public FacesContext getContext()

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

### getException

    public java.lang.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 be `null`.

### 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`.

### 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 java.util.Map<java.lang.Object,java.lang.Object> getAttributes()

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

### getListenersForEventClass

    public java.util.List<SystemEventListener> getListenersForEventClass(java.lang.Class<? extends SystemEvent> facesEventClass)

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

  Specified by:
    `getListenersForEventClass` in interface `SystemEventListenerHolder`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2002-2010 Oracle America Inc, Inc. All Rights Reserved.