public interface ApplicationEventMulticaster
ApplicationListener
objects, and publish events to them.
An ApplicationEventPublisher
, typically
a Spring ApplicationContext
, can use an
ApplicationEventMulticaster as a delegate for actually publishing events.
Modifier and Type | Method and Description |
---|---|
void |
addApplicationListener(ApplicationListener<?> listener)
Add a listener to be notified of all events.
|
void |
addApplicationListenerBean(java.lang.String listenerBeanName)
Add a listener bean to be notified of all events.
|
void |
multicastEvent(ApplicationEvent event)
Multicast the given application event to appropriate listeners.
|
void |
multicastEvent(ApplicationEvent event,
ResolvableType eventType)
Multicast the given application event to appropriate listeners.
|
void |
removeAllListeners()
Remove all listeners registered with this multicaster.
|
void |
removeApplicationListener(ApplicationListener<?> listener)
Remove a listener from the notification list.
|
void |
removeApplicationListenerBean(java.lang.String listenerBeanName)
Remove a listener bean from the notification list.
|
void addApplicationListener(ApplicationListener<?> listener)
listener
- the listener to addvoid addApplicationListenerBean(java.lang.String listenerBeanName)
listenerBeanName
- the name of the listener bean to addvoid removeApplicationListener(ApplicationListener<?> listener)
listener
- the listener to removevoid removeApplicationListenerBean(java.lang.String listenerBeanName)
listenerBeanName
- the name of the listener bean to addvoid removeAllListeners()
After a remove call, the multicaster will perform no action on event notification until new listeners are being registered.
void multicastEvent(ApplicationEvent event)
Consider using multicastEvent(ApplicationEvent, ResolvableType)
if possible as it provides a better support for generics-based events.
event
- the event to multicastvoid multicastEvent(ApplicationEvent event, @Nullable ResolvableType eventType)
If the eventType
is null
, a default type is built
based on the event
instance.
event
- the event to multicasteventType
- the type of event (can be null)