org.kitteh.irc.client.library.feature

Interface EventManager

All Known Implementing Classes:

DefaultEventManager

public interface EventManager

Processes and registers events for a single Client instance. This event manager utilizes MBassador, a lightweight event bus.

Method Summary

Modifier and Type	Method and Description
void	callEvent(@NonNull Object event) Calls an event, triggering any registered methods for the event class.
@NonNull Map<Class<? extends Annotation>,FilterProcessor<?,? extends Annotation>>	getAnnotationFilters() Gets a map of all registered annotation filters.
@NonNull Set<Object>	getRegisteredEventListeners() Gets all registered listener objects.
<A extends Annotation> void	registerAnnotationFilter(Class<A> annotationClass, FilterProcessor<?,A> filterProcessor) Registers an annotation to be used in filtering events if present on a handler method.
void	registerEventListener(@NonNull Object listener) Registers annotated with Handler with sync invocation, provided they have a single parameter.
void	unregisterEventListener(@NonNull Object listener) Unregisters a listener.

Method Detail

callEvent

void callEvent(@NonNull Object event)

Calls an event, triggering any registered methods for the event class.

Parameters:

event - event to call

Throws:

IllegalArgumentException - for a null event

getRegisteredEventListeners

@NonNull Set<Object> getRegisteredEventListeners()

Gets all registered listener objects.

Returns:

a set of objects

getAnnotationFilters

@NonNull Map<Class<? extends Annotation>,FilterProcessor<?,? extends Annotation>> getAnnotationFilters()

Gets a map of all registered annotation filters.

Returns:

a map of annotations to annotation filter processors

registerAnnotationFilter

<A extends Annotation> void registerAnnotationFilter(Class<A> annotationClass,
                                                     FilterProcessor<?,A> filterProcessor)

Registers an annotation to be used in filtering events if present on a handler method. Annotations are only processed on listeners registered after they are added, so add all annotations prior to registering any listeners.

Type Parameters:

A - annotation type

Parameters:

annotationClass - annotation to register

filterProcessor - filter processor to process such annotations

registerEventListener

void registerEventListener(@NonNull Object listener)

Registers annotated with Handler with sync invocation, provided they have a single parameter. This parameter is the event.

Parameters:

listener - listener in which to register events

Throws:

IllegalArgumentException - for a null listener

unregisterEventListener

void unregisterEventListener(@NonNull Object listener)

Unregisters a listener.

Parameters:

listener - listener to unregister

Throws:

IllegalArgumentException - for a null listener