com.sun.faces.application.annotation

Class NamedEventConfigHandler

java.lang.Object

com.sun.faces.application.annotation.NamedEventConfigHandler

All Implemented Interfaces:

ConfigAnnotationHandler

public class NamedEventConfigHandler
extends Object
implements ConfigAnnotationHandler

This class handles the processing the NamedEvent annotation. For each class with this annotation, the following logic is applied:

1. Get the unqualified class name (e.g., UserLoginEvent)
2. Strip off the trailing "Event", if present (e.g., UserLogin)
3. Convert the first character to lower-case (e.g., userLogin)
4. Prepend the package name to the lower-cased name
5. If the shortName attribute is specified, register the event by that name as well.

Constructor Summary

Constructors

Constructor and Description
NamedEventConfigHandler()

Method Summary

Modifier and Type	Method and Description
void	collect(Class<?> target, Annotation annotation) Collect metadata based on the provided Class and Annotation to be processed later by ConfigAnnotationHandler.push(javax.faces.context.FacesContext).
Collection<Class<? extends Annotation>>	getHandledAnnotations()
void	push(javax.faces.context.FacesContext ctx) Push the configuration based on the collected metadata to the current application.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedEventConfigHandler

public NamedEventConfigHandler()

Method Detail

getHandledAnnotations

public Collection<Class<? extends Annotation>> getHandledAnnotations()

Specified by:

getHandledAnnotations in interface ConfigAnnotationHandler

Returns:

a Collection of annotations handled by this ConfigAnnotationHandler implementation

collect

public void collect(Class<?> target,
                    Annotation annotation)

Description copied from interface: ConfigAnnotationHandler

Collect metadata based on the provided Class and Annotation to be processed later by ConfigAnnotationHandler.push(javax.faces.context.FacesContext).

NOTE: This method may be called more than once.

Specified by:

collect in interface ConfigAnnotationHandler

Parameters:

target - annotated class

annotation - Annotation to process

push

public void push(javax.faces.context.FacesContext ctx)

Description copied from interface: ConfigAnnotationHandler

Push the configuration based on the collected metadata to the current application.

Specified by:

push in interface ConfigAnnotationHandler