javax.faces.event.SystemEventListenerHolder Maven / Gradle / Ivy
Show all versions of jsf-api Show documentation
/*
* 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;
import java.util.List;
/**
* Classes that implement this interface
* agree to maintain a list of {@link SystemEventListener} instances
* for each kind of {@link SystemEvent} they can generate. This
* interface enables arbitrary Objects to act as the source for {@link
* SystemEvent} instances.
*
* If the implementing class is a {@link
* javax.faces.component.UIComponent} or is referenced by a
* UIComponent
, care must be taken to ensure that the
* implementing class, and all the members of the list returned by
* {@link #getListenersForEventClass} work correctly with the state
* management system. One way to ensure this is to have the class and
* the list members implement {@link javax.faces.component.StateHolder}
* or {@link java.io.Serializable}.
*
* @since 2.0
*/
public interface SystemEventListenerHolder {
/**
*
* Return a List
of {@link SystemEventListener}
* instances that have been installed into the class implementing
* this interface.
*
*/
public List getListenersForEventClass(Class facesEventClass);
}