jakarta.faces.context.ExceptionHandlerWrapper Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.context;
import jakarta.faces.FacesException;
import jakarta.faces.FacesWrapper;
import jakarta.faces.event.AbortProcessingException;
import jakarta.faces.event.ExceptionQueuedEvent;
import jakarta.faces.event.SystemEvent;
/**
*
* Provides a simple implementation of {@link ExceptionHandler} that can be
* subclassed by developers wishing to provide specialized behavior to an existing {@link ExceptionHandler} instance.
* The default implementation of all methods is to call through to the wrapped {@link ExceptionHandler} instance.
*
*
*
* Usage: extend this class and push the implementation being wrapped to the constructor and use {@link #getWrapped} to
* access the instance being wrapped.
*
*
* @since 2.0
*/
public abstract class ExceptionHandlerWrapper extends ExceptionHandler implements FacesWrapper {
private ExceptionHandler wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public ExceptionHandlerWrapper() {
}
/**
*
* If this exception handler has been decorated, the implementation doing the decorating should push the implementation
* being wrapped to this constructor. The {@link #getWrapped()} will then return the implementation being wrapped.
*
*
* @param wrapped The implementation being wrapped.
* @since 2.3
*/
public ExceptionHandlerWrapper(ExceptionHandler wrapped) {
this.wrapped = wrapped;
}
@Override
public ExceptionHandler getWrapped() {
return wrapped;
}
// ------------------------------------------- Methods from ExceptionHandler
/**
*
* The default behavior of this method is to call {@link ExceptionHandler#getHandledExceptionQueuedEvent()} on the
* wrapped {@link ExceptionHandler} object.
*
*
* @see ExceptionHandler#getHandledExceptionQueuedEvent()
*/
@Override
public ExceptionQueuedEvent getHandledExceptionQueuedEvent() {
return getWrapped().getHandledExceptionQueuedEvent();
}
/**
*
* The default behavior of this method is to call {@link jakarta.faces.context.ExceptionHandler#handle()} on the wrapped
* {@link ExceptionHandler} object.
*
*
* @see jakarta.faces.context.ExceptionHandler#handle()
*/
@Override
public void handle() throws FacesException {
getWrapped().handle();
}
/**
*
* The default behavior of this method is to call
* {@link jakarta.faces.context.ExceptionHandler#isListenerForSource(Object)} on the wrapped {@link ExceptionHandler}
* object.
*
*
* @see jakarta.faces.context.ExceptionHandler#isListenerForSource(Object) ()
*/
@Override
public boolean isListenerForSource(Object source) {
return getWrapped().isListenerForSource(source);
}
/**
*
* The default behavior of this method is to call
* {@link jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent)} on the wrapped
* {@link ExceptionHandler} object.
*
*
* @see jakarta.faces.context.ExceptionHandler#processEvent(jakarta.faces.event.SystemEvent)
*/
@Override
public void processEvent(SystemEvent event) throws AbortProcessingException {
getWrapped().processEvent(event);
}
/**
*
* The default behavior of this method is to call {@link jakarta.faces.context.ExceptionHandler#getRootCause(Throwable)}
* on the wrapped {@link ExceptionHandler} object.
*
*
* @see jakarta.faces.context.ExceptionHandler#getRootCause(Throwable)
*/
@Override
public Throwable getRootCause(Throwable t) {
return getWrapped().getRootCause(t);
}
/**
*
* The default behavior of this method is to call {@link ExceptionHandler#getHandledExceptionQueuedEvents()} on the
* wrapped {@link ExceptionHandler} object.
*
*
* @see ExceptionHandler#getHandledExceptionQueuedEvents()
*/
@Override
public Iterable getHandledExceptionQueuedEvents() {
return getWrapped().getHandledExceptionQueuedEvents();
}
/**
*
* The default behavior of this method is to call {@link ExceptionHandler#getUnhandledExceptionQueuedEvents()} on the
* wrapped {@link ExceptionHandler} object.
*
*
* @see ExceptionHandler#getUnhandledExceptionQueuedEvents()
*/
@Override
public Iterable getUnhandledExceptionQueuedEvents() {
return getWrapped().getUnhandledExceptionQueuedEvents();
}
}