javax.faces.event.ExceptionQueuedEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jsf-api Show documentation
This is the master POM file for Sun's Implementation of the JSF 2.1 Specification.
There is a newer version: 2.2.20
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.faces.event;


/**
 * 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 {
    
    /**
     * 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);
    }

    /**
     * Return the
     * ExceptionQueuedEventContext for this event instance.
     *
     * @since 2.0
     */

    public ExceptionQueuedEventContext getContext() {
	return (ExceptionQueuedEventContext) getSource();
    }

}