Top Description Fields Constructors Methods
jakarta.faces.context

public abstract Class ExceptionHandlerWrapper

extends ExceptionHandler
implements FacesWrapper<ExceptionHandler>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Known Direct Subclasses
com.sun.faces.context.AjaxExceptionHandlerImpl, com.sun.faces.context.AjaxNoAjaxExceptionHandler
Imports
jakarta.faces.FacesException, .FacesWrapper, jakarta.faces.event.AbortProcessingException, .ExceptionQueuedEvent, .SystemEvent

Provides a simple implementation of ExceptionHandler that can be subclassed by developers wishing to provide specialized behavior to an existing ExceptionHandler instance. The default implementation of all methods is to call through to the wrapped ExceptionHandler instance.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.0

Field Summary

Modifier and TypeField and Description
private ExceptionHandler
wrapped

Constructor Summary

AccessConstructor and Description
public
ExceptionHandlerWrapper()
Deprecated Use the other constructor taking the implementation being wrapped.

public
ExceptionHandlerWrapper(ExceptionHandler
The implementation being wrapped.
wrapped)

If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public ExceptionQueuedEvent
getHandledExceptionQueuedEvent()

Implements abstract jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvent.

The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvent() on the wrapped ExceptionHandler object.

public Iterable<ExceptionQueuedEvent>
getHandledExceptionQueuedEvents()

Implements abstract jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvents.

The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.

public Throwable
getRootCause(Throwable
passed-in wrapped Throwable.
t)

Implements abstract jakarta.faces.context.ExceptionHandler.getRootCause.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#getRootCause(Throwable) on the wrapped ExceptionHandler object.

public Iterable<ExceptionQueuedEvent>
getUnhandledExceptionQueuedEvents()

Implements abstract jakarta.faces.context.ExceptionHandler.getUnhandledExceptionQueuedEvents.

The default behavior of this method is to call ExceptionHandler#getUnhandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.

public ExceptionHandler
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

public void
handle()

Implements abstract jakarta.faces.context.ExceptionHandler.handle.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#handle() on the wrapped ExceptionHandler object.

public boolean
isListenerForSource(Object
the source that is inquiring about the appropriateness of sending an event to this listener instance.
source)

Implements abstract jakarta.faces.context.ExceptionHandler.isListenerForSource.

Implements jakarta.faces.event.SystemEventListener.isListenerForSource.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) on the wrapped ExceptionHandler object.

public void
processEvent(SystemEvent
the SystemEvent instance that is being processed.
event)

Implements abstract jakarta.faces.context.ExceptionHandler.processEvent.

Implements jakarta.faces.event.SystemEventListener.processEvent.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent) on the wrapped ExceptionHandler object.

Field Detail

wrappedback to summary
private ExceptionHandler wrapped

Constructor Detail

ExceptionHandlerWrapperback to summary
public ExceptionHandlerWrapper()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
ExceptionHandlerWrapperback to summary
public ExceptionHandlerWrapper(ExceptionHandler wrapped)

If this exception handler has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters
wrapped:ExceptionHandler

The implementation being wrapped.

Since
2.3

Method Detail

getHandledExceptionQueuedEventback to summary
public ExceptionQueuedEvent getHandledExceptionQueuedEvent()

Implements abstract jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvent.

The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvent() on the wrapped ExceptionHandler object.

Returns:ExceptionQueuedEvent

Doc from jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvent.

instance of ExceptionQueuedEvent.

Annotations
@Override
See Also
ExceptionHandler#getHandledExceptionQueuedEvent()
getHandledExceptionQueuedEventsback to summary
public Iterable<ExceptionQueuedEvent> getHandledExceptionQueuedEvents()

Implements abstract jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvents.

The default behavior of this method is to call ExceptionHandler#getHandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.

Returns:Iterable<ExceptionQueuedEvent>

Doc from jakarta.faces.context.ExceptionHandler.getHandledExceptionQueuedEvents.

an Iterable over all ExceptionQueuedEvents.

Annotations
@Override
See Also
ExceptionHandler#getHandledExceptionQueuedEvents()
getRootCauseback to summary
public Throwable getRootCause(Throwable t)

Implements abstract jakarta.faces.context.ExceptionHandler.getRootCause.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#getRootCause(Throwable) on the wrapped ExceptionHandler object.

Parameters
t:Throwable

Doc from jakarta.faces.context.ExceptionHandler.getRootCause.

passed-in wrapped Throwable.

Returns:Throwable

Doc from jakarta.faces.context.ExceptionHandler.getRootCause.

unwrapped object.

Annotations
@Override
See Also
jakarta.faces.context.ExceptionHandler#getRootCause(Throwable)
getUnhandledExceptionQueuedEventsback to summary
public Iterable<ExceptionQueuedEvent> getUnhandledExceptionQueuedEvents()

Implements abstract jakarta.faces.context.ExceptionHandler.getUnhandledExceptionQueuedEvents.

The default behavior of this method is to call ExceptionHandler#getUnhandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.

Returns:Iterable<ExceptionQueuedEvent>

Doc from jakarta.faces.context.ExceptionHandler.getUnhandledExceptionQueuedEvents.

the unhandled set of ExceptionQueuedEvents.

Annotations
@Override
See Also
ExceptionHandler#getUnhandledExceptionQueuedEvents()
getWrappedback to summary
public ExceptionHandler getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:ExceptionHandler

the wrapped instance.

Annotations
@Override
handleback to summary
public void handle() throws FacesException

Implements abstract jakarta.faces.context.ExceptionHandler.handle.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#handle() on the wrapped ExceptionHandler object.

Annotations
@Override
Exceptions
FacesException:

Doc from jakarta.faces.context.ExceptionHandler.handle.

if and only if a problem occurs while performing the algorithm to handle the Exception, not as a means of conveying a handled Exception itself.

See Also
jakarta.faces.context.ExceptionHandler#handle()
isListenerForSourceback to summary
public boolean isListenerForSource(Object source)

Implements abstract jakarta.faces.context.ExceptionHandler.isListenerForSource.

Implements jakarta.faces.event.SystemEventListener.isListenerForSource.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) on the wrapped ExceptionHandler object.

Parameters
source:Object

Doc from jakarta.faces.event.SystemEventListener.isListenerForSource.

the source that is inquiring about the appropriateness of sending an event to this listener instance.

Returns:boolean

Doc from jakarta.faces.event.SystemEventListener.isListenerForSource.

the value as specified above

Annotations
@Override
See Also
()
processEventback to summary
public void processEvent(SystemEvent event) throws AbortProcessingException

Implements abstract jakarta.faces.context.ExceptionHandler.processEvent.

Implements jakarta.faces.event.SystemEventListener.processEvent.

The default behavior of this method is to call jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent) on the wrapped ExceptionHandler object.

Parameters
event:SystemEvent

Doc from jakarta.faces.event.SystemEventListener.processEvent.

the SystemEvent instance that is being processed.

Annotations
@Override
Exceptions
AbortProcessingException:

Doc from jakarta.faces.event.SystemEventListener.processEvent.

if lifecycle processing should cease for this request.

See Also
jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent)