org.openzen.zengarden.events

Class ListenerList<T>

java.lang.Object

org.openzen.zengarden.events.ListenerList<T>

Type Parameters:

T - event type

Direct Known Subclasses:

EventBus

public class ListenerList<T>
extends java.lang.Object

Implements a list of event listeners. This class is thread-safe and listeners can be added or removed concurrently, no external locking is ever needed. Also, it's very lightweight.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ListenerList.EventListenerNode

Field Summary

Fields

Modifier and Type	Field and Description
protected ListenerList.EventListenerNode	first
protected ListenerList.EventListenerNode	last
static int	PRIORITY_DEFAULT
static int	PRIORITY_HIGH
static int	PRIORITY_LOW

Constructor Summary

Constructors

Constructor and Description
ListenerList()

Method Summary

Modifier and Type	Method and Description
void	accept(Consumer<T> consumer) Invokes the given consumer for every listener in the list.
ListenerHandle<T>	add(T listener) Adds an IEventListener to the list.
ListenerHandle<T>	add(T listener, int priority)
void	clear() Clears this listener list.
boolean	isEmpty() Checks if there are any listeners in this list.
boolean	remove(T listener) Removes an IEventListener from the list.

Methods inherited from class java.lang.Object

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

Field Detail

PRIORITY_HIGH

public static final int PRIORITY_HIGH

See Also:

Constant Field Values

PRIORITY_DEFAULT

public static final int PRIORITY_DEFAULT

See Also:

Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

See Also:

Constant Field Values

first

protected volatile ListenerList.EventListenerNode first

last

protected ListenerList.EventListenerNode last

Constructor Detail

ListenerList

public ListenerList()

Method Detail

add

public ListenerHandle<T> add(T listener)

Adds an IEventListener to the list.

Parameters:

listener - event listener

Returns:

event listener's handle

add

public ListenerHandle<T> add(T listener,
                             int priority)

remove

public boolean remove(T listener)

Removes an IEventListener from the list.

Parameters:

listener - listener to be removed

Returns:

true if the listener was removed, false it it wasn't there

clear

public void clear()

Clears this listener list.

accept

public void accept(Consumer<T> consumer)

Invokes the given consumer for every listener in the list.

Parameters:

consumer - consumer to be called for each listener

isEmpty

public boolean isEmpty()

Checks if there are any listeners in this list.

Returns:

true if empty