Package io.microsphere.event

Class AbstractEventDispatcher

java.lang.Object

io.microsphere.event.AbstractEventDispatcher

All Implemented Interfaces:

EventDispatcher, Listenable<EventListener<?>>

Direct Known Subclasses:

DirectEventDispatcher, ParallelEventDispatcher

public abstract class AbstractEventDispatcher
extends java.lang.Object
implements EventDispatcher

The abstract EventDispatcher providers the common implementation.

Since:

1.0.0

See Also:

EventDispatcher, Listenable, ServiceLoader, EventListener, Event

Field Summary

Fields inherited from interface io.microsphere.event.EventDispatcher

DIRECT_EXECUTOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEventDispatcher(java.util.concurrent.Executor executor)	Constructor with an instance of Executor

Method Summary

Modifier and Type	Method	Description
void	addEventListener(EventListener<?> listener)	Add a event listener
void	dispatch(Event event)	Dispatch a event to the registered event listeners
protected void	doInListener(EventListener<?> listener, java.util.function.Consumer<java.util.Collection<EventListener>> consumer)
java.util.List<EventListener<?>>	getAllEventListeners()	Get all registered event listeners
java.util.concurrent.Executor	getExecutor()	The Executor to dispatch a event
protected void	loadEventListenerInstances()	Default, load the instances of event listeners by ServiceLoader
void	removeEventListener(EventListener<?> listener)	Remove a event listener
protected java.util.stream.Stream<EventListener>	sortedListeners()
protected java.util.stream.Stream<EventListener>	sortedListeners(java.util.function.Predicate<? super java.util.Map.Entry<java.lang.Class<? extends Event>,java.util.List<EventListener>>> predicate)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.microsphere.event.Listenable

addEventListeners, addEventListeners, removeAllEventListeners, removeEventListeners

Constructor Detail

AbstractEventDispatcher

protected AbstractEventDispatcher(java.util.concurrent.Executor executor)

Constructor with an instance of Executor

Parameters:

executor - Executor

Throws:

java.lang.NullPointerException - executor is null

Method Detail

addEventListener

public void addEventListener(EventListener<?> listener)
                      throws java.lang.NullPointerException,
                             java.lang.IllegalArgumentException

Description copied from interface: Listenable

Add a event listener

Specified by:

addEventListener in interface Listenable<EventListener<?>>

Parameters:

listener - a event listener If current EventListener is existed, return false

Throws:

java.lang.NullPointerException - if listener argument is null

java.lang.IllegalArgumentException - if listener argument is not concrete instance

removeEventListener

public void removeEventListener(EventListener<?> listener)
                         throws java.lang.NullPointerException,
                                java.lang.IllegalArgumentException

Description copied from interface: Listenable

Remove a event listener

Specified by:

removeEventListener in interface Listenable<EventListener<?>>

Parameters:

listener - a event listener

Throws:

java.lang.NullPointerException - if listener argument is null

java.lang.IllegalArgumentException

getAllEventListeners

public java.util.List<EventListener<?>> getAllEventListeners()

Description copied from interface: Listenable

Get all registered event listeners

Specified by:

getAllEventListeners in interface Listenable<EventListener<?>>

Returns:

non-null read-only ordered event listeners

See Also:

EventListener.getPriority()

sortedListeners

protected java.util.stream.Stream<EventListener> sortedListeners()

sortedListeners

protected java.util.stream.Stream<EventListener> sortedListeners(java.util.function.Predicate<? super java.util.Map.Entry<java.lang.Class<? extends Event>,java.util.List<EventListener>>> predicate)

dispatch

public void dispatch(Event event)

Description copied from interface: EventDispatcher

Dispatch a event to the registered event listeners

Specified by:

dispatch in interface EventDispatcher

Parameters:

event - a event

getExecutor

public final java.util.concurrent.Executor getExecutor()

Description copied from interface: EventDispatcher

The Executor to dispatch a event

Specified by:

getExecutor in interface EventDispatcher

Returns:

the non-null Executor

See Also:

EventDispatcher.DIRECT_EXECUTOR

doInListener

protected void doInListener(EventListener<?> listener,
                            java.util.function.Consumer<java.util.Collection<EventListener>> consumer)

loadEventListenerInstances

protected void loadEventListenerInstances()

Default, load the instances of event listeners by ServiceLoader

It could be override by the sub-class

See Also:

EventListener, ServiceLoader.load(Class)