com.neeve.aep
Class AepEventDispatcher

java.lang.Object
  com.neeve.root.RootObject
      com.neeve.aep.AepEventDispatcher

All Implemented Interfaces:

com.neeve.event.IEventHandler

public final class AepEventDispatcher
extends RootObject
implements com.neeve.event.IEventHandler

Nested Class Summary

static class

AepEventDispatcher.DefaultHandlerDispatchPolicy Enumerates the various default handler dispatch policies

Method Summary

static AepEventDispatcher	create(Set<Object> eventHandlerContainers, com.neeve.event.IEventHandler defaultEventHandler) Create a new event dispatcher
void	dispatchToEventHandlers(Object event) Dispatch an event to its handlers.
AepEventDispatcher.DefaultHandlerDispatchPolicy	getDefaultHandlerDispatchPolicy() Get the default handler dispatch policy
Set<Object>	getEventHandlerContainers() Get the event handler containers
void	onEvent(com.neeve.event.Event event) Implementation of IEventHandler.onEvent(com.neeve.event.Event)
void	setDefaultHandlerDispatchPolicy(AepEventDispatcher.DefaultHandlerDispatchPolicy policy) Set the default handler dispatch policy

Methods inherited from class com.neeve.root.RootObject

getChecked, getThreaded, getTracer, setChecked, setTracer

Methods inherited from class java.lang.Object

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

Method Detail

create

public static final AepEventDispatcher create(Set<Object> eventHandlerContainers,
                                              com.neeve.event.IEventHandler defaultEventHandler)

Create a new event dispatcher

Parameters:

eventHandlerContainers - The objects that contain the event handlers (methods annotated with EventHandler)

defaultEventHandler - The default event handler

getEventHandlerContainers

public final Set<Object> getEventHandlerContainers()

Get the event handler containers

setDefaultHandlerDispatchPolicy

public final void setDefaultHandlerDispatchPolicy(AepEventDispatcher.DefaultHandlerDispatchPolicy policy)

Set the default handler dispatch policy

getDefaultHandlerDispatchPolicy

public final AepEventDispatcher.DefaultHandlerDispatchPolicy getDefaultHandlerDispatchPolicy()

Get the default handler dispatch policy

dispatchToEventHandlers

public final void dispatchToEventHandlers(Object event)

Dispatch an event to its handlers.

Parameters:

event - The event to dispatch. The event's type (class) determines the event handler to which it will be dispatched.

This method dispatches an event to its registered handlers i.e. methods annotated using the EventHandler annotation. The handlers to which the event is dispatched is identified by the event's type (class).

onEvent

public final void onEvent(com.neeve.event.Event event)

Implementation of IEventHandler.onEvent(com.neeve.event.Event)

Specified by:

onEvent in interface com.neeve.event.IEventHandler