Module jakarta.faces

Package jakarta.faces.context

Class ExceptionHandlerWrapper

java.lang.Object

jakarta.faces.context.ExceptionHandler

jakarta.faces.context.ExceptionHandlerWrapper

All Implemented Interfaces:

FacesListener, SystemEventListener, FacesWrapper<ExceptionHandler>, EventListener

Direct Known Subclasses:

AjaxExceptionHandlerImpl, AjaxNoAjaxExceptionHandler

public abstract class ExceptionHandlerWrapper
extends ExceptionHandler
implements FacesWrapper<ExceptionHandler>

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

Constructor Summary

Constructors

Constructor	Description
ExceptionHandlerWrapper()	Deprecated. Use the other constructor taking the implementation being wrapped.
ExceptionHandlerWrapper(ExceptionHandler 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 Type	Method	Description
ExceptionQueuedEvent	getHandledExceptionQueuedEvent()	The default behavior of this method is to call ExceptionHandler.getHandledExceptionQueuedEvent() on the wrapped ExceptionHandler object.
Iterable<ExceptionQueuedEvent>	getHandledExceptionQueuedEvents()	The default behavior of this method is to call ExceptionHandler.getHandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.
Throwable	getRootCause(Throwable t)	The default behavior of this method is to call ExceptionHandler.getRootCause(Throwable) on the wrapped ExceptionHandler object.
Iterable<ExceptionQueuedEvent>	getUnhandledExceptionQueuedEvents()	The default behavior of this method is to call ExceptionHandler.getUnhandledExceptionQueuedEvents() on the wrapped ExceptionHandler object.
ExceptionHandler	getWrapped()	A class that implements this interface uses this method to return an instance of the class being wrapped.
void	handle()	The default behavior of this method is to call ExceptionHandler.handle() on the wrapped ExceptionHandler object.
boolean	isListenerForSource(Object source)	The default behavior of this method is to call ExceptionHandler.isListenerForSource(Object) on the wrapped ExceptionHandler object.
void	processEvent(SystemEvent event)	The default behavior of this method is to call ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent) on the wrapped ExceptionHandler object.

Methods inherited from class java.lang.Object

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

Constructor Details

ExceptionHandlerWrapper

@Deprecated
public ExceptionHandlerWrapper()

Deprecated.

Use the other constructor taking the implementation being wrapped.

ExceptionHandlerWrapper

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 - The implementation being wrapped.

Since:

2.3

Method Details

getWrapped

public ExceptionHandler getWrapped()

Description copied from interface: FacesWrapper

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

Specified by:

getWrapped in interface FacesWrapper<ExceptionHandler>

Returns:

the wrapped instance.

getHandledExceptionQueuedEvent

public ExceptionQueuedEvent getHandledExceptionQueuedEvent()

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

Specified by:

getHandledExceptionQueuedEvent in class ExceptionHandler

Returns:

instance of ExceptionQueuedEvent.

See Also:

• ExceptionHandler.getHandledExceptionQueuedEvent()

handle

public void handle()
            throws FacesException

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

Specified by:

handle in class ExceptionHandler

Throws:

FacesException - 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:

• ExceptionHandler.handle()

isListenerForSource

public boolean isListenerForSource(Object source)

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

Specified by:

isListenerForSource in interface SystemEventListener

Specified by:

isListenerForSource in class ExceptionHandler

Parameters:

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

Returns:

the value as specified above

See Also:

• ()

processEvent

public void processEvent(SystemEvent event)
                  throws AbortProcessingException

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

Specified by:

processEvent in interface SystemEventListener

Specified by:

processEvent in class ExceptionHandler

Parameters:

event - the SystemEvent instance that is being processed.

Throws:

AbortProcessingException - if lifecycle processing should cease for this request.

See Also:

• ExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)

getRootCause

public Throwable getRootCause(Throwable t)

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

Specified by:

getRootCause in class ExceptionHandler

Parameters:

t - passed-in wrapped Throwable.

Returns:

unwrapped object.

See Also:

• ExceptionHandler.getRootCause(Throwable)

getHandledExceptionQueuedEvents

public Iterable<ExceptionQueuedEvent> getHandledExceptionQueuedEvents()

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

Specified by:

getHandledExceptionQueuedEvents in class ExceptionHandler

Returns:

an Iterable over all ExceptionQueuedEvents.

See Also:

• ExceptionHandler.getHandledExceptionQueuedEvents()

getUnhandledExceptionQueuedEvents

public Iterable<ExceptionQueuedEvent> getUnhandledExceptionQueuedEvents()

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

Specified by:

getUnhandledExceptionQueuedEvents in class ExceptionHandler

Returns:

the unhandled set of ExceptionQueuedEvents.

See Also:

• ExceptionHandler.getUnhandledExceptionQueuedEvents()