javax.faces.event.ExceptionQueuedEvent Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* Copyright (c) 1997, 2018 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 javax.faces.event;
import javax.faces.context.FacesContext;
/**
* The system event facility will create an
* instance of this class whenever {@link
* javax.faces.application.Application#publishEvent} is called with
* ExceptionQueuedEvent.class as systemEventClass
* argument. In this case, an instance of {@link ExceptionQueuedEventContext}
* must be passed as the source argument. The specification
* for publishEvent(), requires the instantiation of the
* systemEventClass argument, passing the
* source argument to the constructor.
*
* @since 2.0
*/
public class ExceptionQueuedEvent extends SystemEvent {
private static final long serialVersionUID = -3413872714571466618L;
/**
* Instantiate a new
* ExceptionQueuedEvent that indicates the argument
* ExceptionQueuedEventContext occurred.
*
* @param eventContext the ExceptionQueuedEventContext that
* contextualizes this ExceptionQueuedEvent.
*
* @since 2.0
*/
public ExceptionQueuedEvent(ExceptionQueuedEventContext eventContext) {
super(eventContext);
}
/**
* Instantiate a new
* ExceptionQueuedEvent that indicates the argument
* ExceptionQueuedEventContext occurred.
*
* @param facesContext the Faces context.
* @param eventContext the ExceptionQueuedEventContext that
* contextualizes this ExceptionQueuedEvent.
*
* @since 2.0
*/
public ExceptionQueuedEvent(FacesContext facesContext, ExceptionQueuedEventContext eventContext) {
super(facesContext, eventContext);
}
/**
* Return the
* ExceptionQueuedEventContext for this event instance.
*
* @since 2.0
*
* @return the context
*/
public ExceptionQueuedEventContext getContext() {
return (ExceptionQueuedEventContext) getSource();
}
}