by.bonenaut7.uebus

Class AbstractEventBus

java.lang.Object

by.bonenaut7.uebus.AbstractEventBus

Direct Known Subclasses:

SimpleEventBus

public abstract class AbstractEventBus
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.Class<Event>	EVENT_CLASS
protected java.util.Map<java.lang.Class<? extends Event>,java.util.List<EventRegistration>>	eventRegistry
protected ExceptionHandler	exceptionHandler
protected java.util.concurrent.locks.Lock	readLock
protected java.util.concurrent.locks.ReentrantReadWriteLock	reentrantLock
protected EventRegistrationListFactory	registryListFactory
protected java.util.concurrent.locks.Lock	writeLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractEventBus()
protected	AbstractEventBus(java.util.Map<java.lang.Class<? extends Event>,java.util.List<EventRegistration>> map, EventRegistrationListFactory listFactory)

Method Summary

Modifier and Type	Method and Description
protected static EventListener	checkIsListenerValid(java.lang.reflect.Method method, java.lang.Object instance)
protected java.util.List<EventRegistration>	getListenerRegistrations(java.lang.Class eventType)
protected void	handleException(java.lang.Throwable throwable)
<T extends Event> T	post(T event) Posts an event and returns it.
boolean	postIsCancelled(Event event) Posts an event and returns whether event has been cancelled or not.
<T extends Event> EventRegistration<T>	register(java.lang.Class<T> type, EventDelegate<T> delegate) Registers event listener.
<T extends Event> EventRegistration<T>	register(java.lang.Class<T> type, EventDelegate<T> delegate, boolean ignoreCancellation) Registers event listener.
<T extends Event> EventRegistration<T>	register(java.lang.Class<T> type, EventDelegate<T> delegate, int priority) Registers event listener.
<T extends Event> EventRegistration<T>	register(java.lang.Class<T> type, EventDelegate<T> delegate, int priority, boolean ignoreCancellation) Registers event listener.
void	register(java.lang.Object eventHandler) Looks for plain(non-static) annotated methods and registers them as an event listeners.
java.util.List<EventRegistration>	register(java.lang.Object eventHandler, java.util.List<EventRegistration> out) Looks for plain(non-static) annotated methods and registers them as an event listeners.
protected void	registerAnnotated(java.lang.Class<?> type, java.lang.Object instance, boolean registerStatic, java.util.List<EventRegistration> registrationsOut)
void	registerStatic(java.lang.Class<?> eventHandler) Looks for static annotated methods and registers them as an event listeners.
java.util.List<EventRegistration>	registerStatic(java.lang.Class<?> eventHandler, java.util.List<EventRegistration> out) Looks for static annotated methods and registers them as an event listeners.
void	setExceptionHandler(ExceptionHandler exceptionHandler) Sets an exception handler for the event bus.
boolean	unregister(EventRegistration registration) Unregisters event listener.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_CLASS

protected static final java.lang.Class<Event> EVENT_CLASS

reentrantLock

protected final java.util.concurrent.locks.ReentrantReadWriteLock reentrantLock

readLock

protected final java.util.concurrent.locks.Lock readLock

writeLock

protected final java.util.concurrent.locks.Lock writeLock

eventRegistry

protected final java.util.Map<java.lang.Class<? extends Event>,java.util.List<EventRegistration>> eventRegistry

registryListFactory

protected EventRegistrationListFactory registryListFactory

exceptionHandler

protected ExceptionHandler exceptionHandler

Constructor Detail

AbstractEventBus

protected AbstractEventBus()

AbstractEventBus

protected AbstractEventBus(java.util.Map<java.lang.Class<? extends Event>,java.util.List<EventRegistration>> map,
                           EventRegistrationListFactory listFactory)

Method Detail

setExceptionHandler

public void setExceptionHandler(ExceptionHandler exceptionHandler)

Sets an exception handler for the event bus. All exceptions will be passed through the specified exception handler, including registration ones.

Parameters:

exceptionHandler - The exception handler

register

public <T extends Event> EventRegistration<T> register(java.lang.Class<T> type,
                                                       EventDelegate<T> delegate)

Registers event listener.

Type Parameters:

T - Event type

Parameters:

type - Event class object

delegate - Listener delegate

Returns:

Event registration object if succeed, null otherwise.

register

public <T extends Event> EventRegistration<T> register(java.lang.Class<T> type,
                                                       EventDelegate<T> delegate,
                                                       int priority)

Registers event listener.

Type Parameters:

T - Event type

Parameters:

type - Event class object

delegate - Listener delegate

priority - Listener priority

Returns:

Event registration object if succeed, null otherwise.

register

public <T extends Event> EventRegistration<T> register(java.lang.Class<T> type,
                                                       EventDelegate<T> delegate,
                                                       boolean ignoreCancellation)

Registers event listener.

Type Parameters:

T - Event type

Parameters:

type - Event class object

delegate - Listener delegate

ignoreCancellation - The flag that indicates whether listener will ignore cancelled methods or not.

Returns:

Event registration object if succeed, null otherwise.

register

public <T extends Event> EventRegistration<T> register(java.lang.Class<T> type,
                                                       EventDelegate<T> delegate,
                                                       int priority,
                                                       boolean ignoreCancellation)

Registers event listener.

Type Parameters:

T - Event type

Parameters:

type - Event class object

delegate - Listener delegate

priority - Listener priority

ignoreCancellation - The flag that indicates whether listener will ignore cancelled methods or not.

Returns:

Event registration object if succeed, null otherwise.

register

public void register(java.lang.Object eventHandler)

Looks for plain(non-static) annotated methods and registers them as an event listeners.

Parameters:

eventHandler - The object with annotated methods.

register

public java.util.List<EventRegistration> register(java.lang.Object eventHandler,
                                                  java.util.List<EventRegistration> out)

Looks for plain(non-static) annotated methods and registers them as an event listeners.

Parameters:

eventHandler - The object with annotated methods

out - The list to which listener registrations will be added

Returns:

out parameter with event registrations added.

registerStatic

public void registerStatic(java.lang.Class<?> eventHandler)

Looks for static annotated methods and registers them as an event listeners.

Parameters:

eventHandler - The class object with annotated methods

registerStatic

public java.util.List<EventRegistration> registerStatic(java.lang.Class<?> eventHandler,
                                                        java.util.List<EventRegistration> out)

Looks for static annotated methods and registers them as an event listeners.

Parameters:

eventHandler - The class object with annotated methods

out - The list to which listener registrations will be added

Returns:

out parameter with event registrations added.

unregister

public boolean unregister(EventRegistration registration)

Unregisters event listener.

Parameters:

registration - The listener registration

Returns:

true if succeed, false otherwise.

post

public <T extends Event> T post(T event)

Posts an event and returns it.

Type Parameters:

T - An event type.

Parameters:

event - An event to be posted.

Returns:

Specified event parameter.

postIsCancelled

public boolean postIsCancelled(Event event)

Posts an event and returns whether event has been cancelled or not.

Parameters:

event - An event to be posted.

Returns:

true if event has not been cancelled, false otherwise.

handleException

protected void handleException(java.lang.Throwable throwable)

getListenerRegistrations

protected java.util.List<EventRegistration> getListenerRegistrations(java.lang.Class eventType)

registerAnnotated

protected final void registerAnnotated(java.lang.Class<?> type,
                                       java.lang.Object instance,
                                       boolean registerStatic,
                                       java.util.List<EventRegistration> registrationsOut)

checkIsListenerValid

protected static final EventListener checkIsListenerValid(java.lang.reflect.Method method,
                                                          java.lang.Object instance)