程序包 cn.taketoday.context.event

类 AbstractApplicationEventMulticaster

java.lang.Object

cn.taketoday.context.event.AbstractApplicationEventMulticaster

所有已实现的接口:

Aware, BeanClassLoaderAware, BeanFactoryAware, ApplicationEventMulticaster

直接已知子类:

SimpleApplicationEventMulticaster

public abstract class AbstractApplicationEventMulticaster
extends Object
implements ApplicationEventMulticaster, BeanClassLoaderAware, BeanFactoryAware

Abstract implementation of the ApplicationEventMulticaster interface, providing the basic listener registration facility.

Doesn't permit multiple instances of the same listener by default, as it keeps listeners in a linked Set. The collection class used to hold ApplicationListener objects can be overridden through the "collectionClass" bean property.

Implementing ApplicationEventMulticaster's actual ApplicationEventMulticaster.multicastEvent(cn.taketoday.context.ApplicationEvent) method is left to subclasses. SimpleApplicationEventMulticaster simply multicasts all events to all registered listeners, invoking them in the calling thread. Alternative implementations could be more sophisticated in those respects.

从以下版本开始:

4.0

作者:

Juergen Hoeller, Stephane Nicoll, Harry Yang

另请参阅:

• getApplicationListeners(ApplicationEvent, ResolvableType)
• SimpleApplicationEventMulticaster

构造器概要

构造器

构造器	说明
AbstractApplicationEventMulticaster()

方法概要

修饰符和类型	方法	说明
void	addApplicationListener(ApplicationListener listener)	Add a listener to be notified of all events.
void	addApplicationListenerBean(String listenerBeanName)	Add a listener bean to be notified of all events.
protected Collection<ApplicationListener<?>>	getApplicationListeners()	Return a Collection containing all ApplicationListeners.
protected Collection<ApplicationListener<?>>	getApplicationListeners(ApplicationEvent event, cn.taketoday.core.ResolvableType eventType)	Return a Collection of ApplicationListeners matching the given event type.
void	removeAllListeners()	Remove all listeners registered with this multicaster.
void	removeApplicationListener(ApplicationListener<?> listener)	Remove a listener from the notification list.
void	removeApplicationListenerBean(String listenerBeanName)	Remove a listener bean from the notification list.
void	removeApplicationListenerBeans(Predicate<String> predicate)	Remove all matching listener beans from the set of registered listener bean names (referring to bean classes which in turn implement the ApplicationListener interface directly).
void	removeApplicationListeners(Predicate<ApplicationListener<?>> predicate)	Remove all matching listeners from the set of registered ApplicationListener instances (which includes adapter classes such as ApplicationListenerMethodAdapter, e.g. for annotated EventListener methods).
void	setBeanClassLoader(ClassLoader classLoader)
void	setBeanFactory(BeanFactory beanFactory)
protected boolean	supportsEvent(ApplicationListener<?> listener, cn.taketoday.core.ResolvableType eventType, Class<?> sourceType)	Determine whether the given listener supports the given event.
protected boolean	supportsEvent(Class<?> listenerType, cn.taketoday.core.ResolvableType eventType)	Filter a listener early through checking its generically declared event type before trying to instantiate it.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.taketoday.context.event.ApplicationEventMulticaster

multicastEvent, multicastEvent

构造器详细资料

AbstractApplicationEventMulticaster

public AbstractApplicationEventMulticaster()

方法详细资料

setBeanClassLoader

public void setBeanClassLoader(@Nullable
 ClassLoader classLoader)

指定者:

setBeanClassLoader 在接口中 BeanClassLoaderAware

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

指定者:

setBeanFactory 在接口中 BeanFactoryAware

addApplicationListener

public void addApplicationListener(ApplicationListener listener)

从接口复制的说明: ApplicationEventMulticaster

Add a listener to be notified of all events.

指定者:

addApplicationListener 在接口中 ApplicationEventMulticaster

参数:

listener - the listener to add

另请参阅:

• ApplicationEventMulticaster.removeApplicationListener(ApplicationListener)
• ApplicationEventMulticaster.removeApplicationListeners(Predicate)

addApplicationListenerBean

public void addApplicationListenerBean(String listenerBeanName)

从接口复制的说明: ApplicationEventMulticaster

Add a listener bean to be notified of all events.

指定者:

addApplicationListenerBean 在接口中 ApplicationEventMulticaster

参数:

listenerBeanName - the name of the listener bean to add

另请参阅:

• ApplicationEventMulticaster.removeApplicationListenerBean(String)
• ApplicationEventMulticaster.removeApplicationListenerBeans(Predicate)

removeApplicationListener

public void removeApplicationListener(ApplicationListener<?> listener)

从接口复制的说明: ApplicationEventMulticaster

Remove a listener from the notification list.

指定者:

removeApplicationListener 在接口中 ApplicationEventMulticaster

参数:

listener - the listener to remove

另请参阅:

• ApplicationEventMulticaster.addApplicationListener(ApplicationListener)
• ApplicationEventMulticaster.removeApplicationListeners(Predicate)

removeApplicationListenerBean

public void removeApplicationListenerBean(String listenerBeanName)

从接口复制的说明: ApplicationEventMulticaster

Remove a listener bean from the notification list.

指定者:

removeApplicationListenerBean 在接口中 ApplicationEventMulticaster

参数:

listenerBeanName - the name of the listener bean to remove

另请参阅:

• ApplicationEventMulticaster.addApplicationListenerBean(String)
• ApplicationEventMulticaster.removeApplicationListenerBeans(Predicate)

removeApplicationListeners

public void removeApplicationListeners(Predicate<ApplicationListener<?>> predicate)

从接口复制的说明: ApplicationEventMulticaster

Remove all matching listeners from the set of registered ApplicationListener instances (which includes adapter classes such as ApplicationListenerMethodAdapter, e.g. for annotated EventListener methods).

Note: This just applies to instance registrations, not to listeners registered by bean name.

指定者:

removeApplicationListeners 在接口中 ApplicationEventMulticaster

参数:

predicate - the predicate to identify listener instances to remove, e.g. checking SmartApplicationListener.getListenerId()

另请参阅:

• ApplicationEventMulticaster.addApplicationListener(ApplicationListener)
• ApplicationEventMulticaster.removeApplicationListener(ApplicationListener)

removeApplicationListenerBeans

public void removeApplicationListenerBeans(Predicate<String> predicate)

从接口复制的说明: ApplicationEventMulticaster

Remove all matching listener beans from the set of registered listener bean names (referring to bean classes which in turn implement the ApplicationListener interface directly).

Note: This just applies to bean name registrations, not to programmatically registered ApplicationListener instances.

指定者:

removeApplicationListenerBeans 在接口中 ApplicationEventMulticaster

参数:

predicate - the predicate to identify listener bean names to remove

另请参阅:

• ApplicationEventMulticaster.addApplicationListenerBean(String)
• ApplicationEventMulticaster.removeApplicationListenerBean(String)

removeAllListeners

public void removeAllListeners()

从接口复制的说明: ApplicationEventMulticaster

Remove all listeners registered with this multicaster.

After a remove call, the multicaster will perform no action on event notification until new listeners are registered.

指定者:

removeAllListeners 在接口中 ApplicationEventMulticaster

另请参阅:

• ApplicationEventMulticaster.removeApplicationListeners(Predicate)

getApplicationListeners

protected Collection<ApplicationListener<?>> getApplicationListeners()

Return a Collection containing all ApplicationListeners.

返回:

a Collection of ApplicationListeners

另请参阅:

• ApplicationListener

getApplicationListeners

protected Collection<ApplicationListener<?>> getApplicationListeners(ApplicationEvent event,
 cn.taketoday.core.ResolvableType eventType)

Return a Collection of ApplicationListeners matching the given event type. Non-matching listeners get excluded early.

参数:

event - the event to be propagated. Allows for excluding non-matching listeners early, based on cached matching information.

eventType - the event type

返回:

a Collection of ApplicationListeners

另请参阅:

• ApplicationListener

supportsEvent

protected boolean supportsEvent(Class<?> listenerType,
 cn.taketoday.core.ResolvableType eventType)

Filter a listener early through checking its generically declared event type before trying to instantiate it.

If this method returns true for a given listener as a first pass, the listener instance will get retrieved and fully evaluated through a supportsEvent(ApplicationListener, ResolvableType, Class) call afterwards.

参数:

listenerType - the listener's type as determined by the BeanFactory

eventType - the event type to check

返回:

whether the given listener should be included in the candidates for the given event type

supportsEvent

protected boolean supportsEvent(ApplicationListener<?> listener,
 cn.taketoday.core.ResolvableType eventType,
 @Nullable
 Class<?> sourceType)

Determine whether the given listener supports the given event.

The default implementation detects the SmartApplicationListener and GenericApplicationListener interfaces. In case of a standard ApplicationListener, a GenericApplicationListenerAdapter will be used to introspect the generically declared type of the target listener.

参数:

listener - the target listener to check

eventType - the event type to check against

sourceType - the source type to check against

返回:

whether the given listener should be included in the candidates for the given event type