org.openzen.zengarden.events

Class EventBus<T>

java.lang.Object

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

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

Type Parameters:

T - event type

Direct Known Subclasses:

CancelableEventBus

public class EventBus<T>
extends ListenerList<EventListener<T>>

Represents an event bus. An event bus is similar to a listener list, except that it can only contain EventListeners, which have only one event function accepting a single parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	EventBus.SubclassEventListener<E extends T,T> A wrapper for an event listener that only accepts a specific type of event.

Nested classes/interfaces inherited from class org.openzen.zengarden.events.ListenerList

ListenerList.EventListenerNode

Field Summary

Fields inherited from class org.openzen.zengarden.events.ListenerList

first, last, PRIORITY_DEFAULT, PRIORITY_HIGH, PRIORITY_LOW

Constructor Summary

Constructors

Constructor and Description
EventBus()

Method Summary

Modifier and Type	Method and Description
<E extends T> ListenerHandle<EventListener<T>>	add(EventListener<E> listener, java.lang.Class<E> clazz) Adds an IEventListener to the list that only accepts a specific subclass of <T>
<E extends T> ListenerHandle<EventListener<T>>	add(EventListener<E> listener, java.lang.Class<E> clazz, int priority) Adds an IEventListener to the list that only accepts a specific subclass of <T>
void	publish(T event) Publishes an event by calling all of the registered listeners.

Methods inherited from class org.openzen.zengarden.events.ListenerList

accept, add, add, clear, isEmpty, remove

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBus

public EventBus()

Method Detail

publish

public void publish(T event)

Publishes an event by calling all of the registered listeners.

Parameters:

event - event to be published

add

public <E extends T> ListenerHandle<EventListener<T>> add(EventListener<E> listener,
                                                          java.lang.Class<E> clazz)

Adds an IEventListener to the list that only accepts a specific subclass of <T>

Type Parameters:

E - event type

Parameters:

listener - listener to register

clazz - class to listen for

Returns:

event listener's handle

add

public <E extends T> ListenerHandle<EventListener<T>> add(EventListener<E> listener,
                                                          java.lang.Class<E> clazz,
                                                          int priority)

Adds an IEventListener to the list that only accepts a specific subclass of <T>

Type Parameters:

E - event type

Parameters:

listener - listener to register

clazz - class to listen for

priority - listener priority

Returns:

event listener's handle