Top Description Methods
jakarta.faces.event

public Interface SystemEventListener

extends FacesListener
Known Direct Subinterfaces
jakarta.faces.event.ViewMapListener
Known Direct Implementers
jakarta.faces.component.UIComponent.ComponentSystemEventListenerAdapter, jakarta.faces.context.ExceptionHandler

By implementing this class, an object indicates that it is a listener for one or more kinds of SystemEvents. The exact type of event that will cause the implementing class's processEvent method to be called is indicated by the facesEventClass argument passed when the listener is installed using jakarta.faces.application.Application#subscribeToEvent.

Since
2.0

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

the value as specified above
isListenerForSource(Object
the source that is inquiring about the appropriateness of sending an event to this listener instance.
source)

This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.

public void
processEvent(SystemEvent
the SystemEvent instance that is being processed.
event)

When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Method Detail

isListenerForSourceback to summary
public boolean isListenerForSource(Object source)

This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.

Parameters
source:Object

the source that is inquiring about the appropriateness of sending an event to this listener instance.

Returns:boolean

the value as specified above

processEventback to summary
public void processEvent(SystemEvent event) throws AbortProcessingException

When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Parameters
event:SystemEvent

the SystemEvent instance that is being processed.

Exceptions
AbortProcessingException:
if lifecycle processing should cease for this request.