Module jakarta.faces

Package jakarta.faces.event

Annotation Interface NamedEvent

@Documented
@Retention(RUNTIME)
@Target(TYPE)
@Inherited
public @interface NamedEvent

The presence of this annotation on a class automatically registers the class with the runtime as a ComponentSystemEvent for use with the <f:event /> tag in a page. The value of the shortName() attribute is taken to be the short name for the ComponentSystemEvent. If the shortName has already been registered, the current class must be added to a List of of duplicate events for that name. If the event name is then referenced by an application, a FacesException must be thrown listing the shortName and the offending classes.

Since:

2.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	shortName	The value of this annotation attribute is taken to be the short name for the ComponentSystemEvent.

Element Details

shortName

String shortName

The value of this annotation attribute is taken to be the short name for the ComponentSystemEvent. If the value of this attribute is ommitted, the following algorithm must be used by the code that processes this annotation to determine its value.

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.

Returns:

the short name

Default:

""