Package io.microsphere.event

Interface Listenable<E extends EventListener<?>>

All Known Subinterfaces:

EventDispatcher

All Known Implementing Classes:

AbstractEventDispatcher, DirectEventDispatcher, ParallelEventDispatcher

public interface Listenable<E extends EventListener<?>>

Event Listenable

Since:

1.0.0

See Also:

EventDispatcher

Method Summary

Modifier and Type	Method	Description
void	addEventListener(E listener)	Add a event listener
default void	addEventListeners(E listener, E... others)	Add one or more event listeners
default void	addEventListeners(java.lang.Iterable<E> listeners)	Add multiple event listeners
static void	assertListener(EventListener<?> listener)	Assets the listener is valid or not, rules: the listener must not be null the class of listener must not be final
java.util.List<E>	getAllEventListeners()	Get all registered event listeners
default void	removeAllEventListeners()	Remove all event listeners
void	removeEventListener(E listener)	Remove a event listener
default void	removeEventListeners(java.lang.Iterable<E> listeners)	Remove a event listener

Method Detail

assertListener

static void assertListener(EventListener<?> listener)
                    throws java.lang.IllegalArgumentException

Assets the listener is valid or not, rules:

• the listener must not be null
• the class of listener must not be final

Parameters:

listener - the instance of EventListener

Throws:

java.lang.IllegalArgumentException

addEventListener

void addEventListener(E listener)
               throws java.lang.NullPointerException,
                      java.lang.IllegalArgumentException

Add a event listener

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

addEventListeners

default void addEventListeners(E listener,
                               E... others)
                        throws java.lang.NullPointerException,
                               java.lang.IllegalArgumentException

Add one or more event listeners

Parameters:

listener - a event listener

others - an optional event listeners

Throws:

java.lang.NullPointerException - if one of arguments is null

java.lang.IllegalArgumentException - if one of arguments argument is not concrete instance

addEventListeners

default void addEventListeners(java.lang.Iterable<E> listeners)
                        throws java.lang.NullPointerException,
                               java.lang.IllegalArgumentException

Add multiple event listeners

Parameters:

listeners - the event listeners

Throws:

java.lang.NullPointerException - if listeners argument is null

java.lang.IllegalArgumentException - if any element of listeners is not concrete instance

removeEventListener

void removeEventListener(E listener)
                  throws java.lang.NullPointerException,
                         java.lang.IllegalArgumentException

Remove a event listener

Parameters:

listener - a event listener

Throws:

java.lang.NullPointerException - if listener argument is null

java.lang.IllegalArgumentException

removeEventListeners

default void removeEventListeners(java.lang.Iterable<E> listeners)
                           throws java.lang.NullPointerException,
                                  java.lang.IllegalArgumentException

Remove a event listener

Parameters:

listeners - the event listeners

Throws:

java.lang.NullPointerException - if listener argument is null

java.lang.IllegalArgumentException - if any element of listeners is not concrete instance

removeAllEventListeners

default void removeAllEventListeners()

Remove all event listeners

getAllEventListeners

java.util.List<E> getAllEventListeners()

Get all registered event listeners

Returns:

non-null read-only ordered event listeners

See Also:

EventListener.getPriority()