org.apache.myfaces.config
Class NamedEventManager

java.lang.Object
  org.apache.myfaces.config.NamedEventManager

public class NamedEventManager
extends java.lang.Object

The NamedEventManager class is used to keep map a short name to ComponentSystemEvent classes annotated with @NamedEvent.

Method Summary

void	addNamedEvent(java.lang.String shortName, java.lang.Class<? extends javax.faces.event.ComponentSystemEvent> cls) Registers a named event.
static NamedEventManager	getInstance()
java.util.Collection<java.lang.Class<? extends javax.faces.event.ComponentSystemEvent>>	getNamedEvent(java.lang.String shortName) Retrieves a collection of system event classes based on their short name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static NamedEventManager getInstance()

addNamedEvent

public void addNamedEvent(java.lang.String shortName,
                          java.lang.Class<? extends javax.faces.event.ComponentSystemEvent> cls)

Registers a named event.

Parameters:

shortName - a String containing the short name for the event, from the @NamedEvent.shortName() attribute.

cls - the event class to register.

getNamedEvent

public java.util.Collection<java.lang.Class<? extends javax.faces.event.ComponentSystemEvent>> getNamedEvent(java.lang.String shortName)

Retrieves a collection of system event classes based on their short name.

Parameters:

shortName - the short name to look up.

Returns:

a Collection of Class objects containing the system event classes registered to the given short name.