Package org.springframework.context
Interface ApplicationListener<E extends ApplicationEvent>
- Type Parameters:
E- the specificApplicationEventsubclass to listen to
- All Superinterfaces:
EventListener
- All Known Subinterfaces:
GenericApplicationListener,SmartApplicationListener,TransactionalApplicationListener<E>
- All Known Implementing Classes:
ApplicationListenerMethodAdapter,DefaultSimpUserRegistry,GenericApplicationListenerAdapter,JmsListenerEndpointRegistry,MultiServerUserRegistry,ResourceUrlProvider,ResourceUrlProvider,ScheduledAnnotationBeanPostProcessor,SourceFilteringListener,TransactionalApplicationListenerAdapter,TransactionalApplicationListenerMethodAdapter,UserRegistryMessageHandler
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface
public interface ApplicationListener<E extends ApplicationEvent>
extends EventListener
Interface to be implemented by application event listeners.
Based on the standard java.util.EventListener interface
for the Observer design pattern.
As of Spring 3.0, an ApplicationListener can generically declare
the event type that it is interested in. When registered with a Spring
ApplicationContext, events will be filtered accordingly, with the
listener getting invoked for matching event objects only.
- Author:
- Rod Johnson, Juergen Hoeller
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic <T> ApplicationListener<PayloadApplicationEvent<T>>forPayload(Consumer<T> consumer) Create a newApplicationListenerfor the given payload consumer.voidonApplicationEvent(E event) Handle an application event.
-
Method Details
-
onApplicationEvent
Handle an application event.- Parameters:
event- the event to respond to
-
forPayload
Create a newApplicationListenerfor the given payload consumer.- Type Parameters:
T- the type of the event payload- Parameters:
consumer- the event payload consumer- Returns:
- a corresponding
ApplicationListenerinstance - Since:
- 5.3
- See Also:
-