Top Description Methods
jakarta.faces.event

public @Interface NamedEvent

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:TYPE
@Inherited
Imports
java.lang.annotation.Documented, .ElementType, .Inherited, .Retention, .RetentionPolicy, .Target

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 jakarta.faces.event.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

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the short name
shortName()

The value of this annotation attribute is taken to be the short name for the jakarta.faces.event.ComponentSystemEvent.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

shortNameback to summary
public String shortName()

The value of this annotation attribute is taken to be the short name for the jakarta.faces.event.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:String

the short name