de.schlegel11.eventdispatcher

Class EventDispatcher

java.lang.Object

de.schlegel11.eventdispatcher.EventDispatcher

public final class EventDispatcher
extends Object

Class that provides an easy to use event dispatcher.

Version:

1.1

Author:

Marcel Schlegel (schlegel11) on 20.10.14

Method Summary

Modifier and Type	Method and Description
boolean	addListener(Class<? extends EventListener> clazz, EventListener listener) Adds a new EventListener class instance.
boolean	addListener(Class<? extends EventListener> clazz, EventListener listener, int maxCalls) Adds a new EventListener class instance with a maximum number of EventListener calls.
void	clear() Removes all EventListener class type and listener instances.
boolean	equals(Object obj)
<T extends EventListener> boolean	fireEvent(Class<T> clazz, Consumer<T> consumer) Handel the Consumer lambda expression for all EventListener class instances of a specific EventListener class type.
int	getListenerCount() Returns the number of all EventListener class instances.
int	getListenerCount(Class<? extends EventListener> clazz) Returns the number of all EventListener class instances associated with a specific EventListener class type.
int	getListenerCurrentCalls(Class<? extends EventListener> clazz, EventListener listener) Returns the number of current calls for the specific EventListener class instance.
int	getListenerMaxCalls(Class<? extends EventListener> clazz, EventListener listener) Returns the number of maximum calls for the specific EventListener class instance.
int	getListenerTypeCount() Returns the number of all EventListener class types.
int	hashCode()
static EventDispatcher	newInstance() Factory method that creates a new EventDispatcher instance.
boolean	removeListener(Class<? extends EventListener> clazz, EventListener listener) Removes a EventListener class instance from a specific EventListener class type.
boolean	removeListenerType(Class<? extends EventListener> clazz) Removes a specific EventListener class type and all associated EventListener instances.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static EventDispatcher newInstance()

Factory method that creates a new EventDispatcher instance.

Returns:

A new EventDispatcher instance.

addListener

public boolean addListener(Class<? extends EventListener> clazz,
                           EventListener listener)

Adds a new EventListener class instance.

The EventListener class instance is assigned to a specific EventListener class type.
A specific EventListener class type assigns many EventListener class instances.

Parameters:

clazz - Represents a specific unique EventListener class type. If param is null a NullPointerException is thrown.

listener - Represents a specific EventListener instance. If param is null a NullPointerException is thrown.

Returns:

True if the current EventDispatcher did not already contain the specific listener instance.

addListener

public boolean addListener(Class<? extends EventListener> clazz,
                           EventListener listener,
                           int maxCalls)

Adds a new EventListener class instance with a maximum number of EventListener calls.
In case of infinite calls please use addListener(Class, java.util.EventListener)

The EventListener class instance is assigned to a specific EventListener class type.
A specific EventListener class type assigns many EventListener class instances.

Parameters:

clazz - Represents a specific unique EventListener class type. If param is null a NullPointerException is thrown.

listener - Represents a specific EventListener instance. If param is null a NullPointerException is thrown.

maxCalls - Represents a maximum number of calls for the specific EventListener instance. The value -1 represents infinite calls. If param is less or equal 0 (except -1) an IllegalArgumentException is thrown.

Returns:

True if the current EventDispatcher did not already contain the specific listener instance.

removeListener

public boolean removeListener(Class<? extends EventListener> clazz,
                              EventListener listener)

Removes a EventListener class instance from a specific EventListener class type.
If the EventListener class type has no more EventListener class instances it will also be removed.

Parameters:

clazz - Represents a specific EventListener class type.

listener - Represents a specific EventListener instance.

Returns:

True if the current EventDispatcher contains the specific clazz type and listener instance.

removeListenerType

public boolean removeListenerType(Class<? extends EventListener> clazz)

Removes a specific EventListener class type and all associated EventListener instances.

Parameters:

clazz - Represents a specific EventListener class type.

Returns:

True if the current EventDispatcher contains the specific clazz type and removed it.

clear

public void clear()

Removes all EventListener class type and listener instances. The current EventDispatcher will be empty after this call returns.

getListenerCount

public int getListenerCount()

Returns the number of all EventListener class instances.

Returns:

Number of all EventListener class instances.

getListenerCount

public int getListenerCount(Class<? extends EventListener> clazz)

Returns the number of all EventListener class instances associated with a specific EventListener class type.

Parameters:

clazz - Represents a specific EventListener class type.

Returns:

Number of all EventListener class instances associated with a specific EventListener class type.
If specific clazz type did not exist returns 0.

getListenerTypeCount

public int getListenerTypeCount()

Returns the number of all EventListener class types.

Returns:

Number of all EventListener class types.

getListenerMaxCalls

public int getListenerMaxCalls(Class<? extends EventListener> clazz,
                               EventListener listener)

Returns the number of maximum calls for the specific EventListener class instance.

Parameters:

clazz - Represents a specific EventListener class type.

listener - Represents a specific EventListener instance.

Returns:

The number of maximum calls for the specific EventListener class instance.
If specific EventListener instance did not exist returns 0.
If specific EventListener instance have infinite calls returns -1.

getListenerCurrentCalls

public int getListenerCurrentCalls(Class<? extends EventListener> clazz,
                                   EventListener listener)

Returns the number of current calls for the specific EventListener class instance.

Parameters:

clazz - Represents a specific EventListener class type.

listener - Represents a specific EventListener instance.

Returns:

The number of current calls for the specific EventListener class instance.
If specific EventListener instance did not exist returns 0.
If specific EventListener instance have infinite calls returns 0.

fireEvent

public <T extends EventListener> boolean fireEvent(Class<T> clazz,
                                                   Consumer<T> consumer)

Handel the Consumer lambda expression for all EventListener class instances of a specific EventListener class type.
If the "maxCalls" (addListener(Class, java.util.EventListener, int)) value of the EventListener class instance is reached the instance will be removed.
The Consumer input argument is automatically mapped to the clazz type parameter.

Event methods can be handled like this:

 fireEvent(SpecificEventListener.class, l  -> l.specificEventListenerMethod(...));
 

 or for multiple method calls
 

 fireEvent(SpecificEventListener.class, l  -> {
 l.specificEventListenerMethod(...);
 l.anotherSpecificEventListenerMethod(...);
 });
 

Type Parameters:

T - A specific EventListener type that extends from EventListener interface.

Parameters:

clazz - Represents a specific EventListener class type. Return False if param is null or current EventDispatcher did not contain type.

consumer - Represents an operation normally for specific EventListener instances. Return False if param is null.

Returns:

True if Consumer operation is successfully handled.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object