ninja.ugly.prevail.event.dispatcher

Interface EventDispatcher

All Known Implementing Classes:

CompositeEventDispatcher, EventBusEventDispatcher, EventDispatcher.EmptyEventDispatcher, ExecutorEventDispatcher

public interface EventDispatcher

An EventDispatcher is responsible for delivering events generated by EventFactories during operations on Chunks.

This interface is intended to be implemented by instances that use, for example, Guava's EventBus or GreenRobot's EventBus on Android. Such implementations use runtime types to match events to subscribers. As such, the methods in this class are type-free.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventDispatcher.EmptyEventDispatcher An empty implementation of the EventDispatcher.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatchEvent(java.lang.Object event) Dispatch an arbitrary event object to the registered subscribers.
void	register(java.lang.Object subscriber) Register a subscriber with this EventDispatcher.
void	unregister(java.lang.Object subscriber) Unregister a subscriber from this EventDispatcher.

Method Detail

dispatchEvent

void dispatchEvent(java.lang.Object event)

Dispatch an arbitrary event object to the registered subscribers.

Parameters:

event - The event to dispatch.

register

void register(java.lang.Object subscriber)

Register a subscriber with this EventDispatcher.

Parameters:

subscriber - The subscriber to register.

unregister

void unregister(java.lang.Object subscriber)

Unregister a subscriber from this EventDispatcher.

Parameters:

subscriber - The subscriber to unregister.