org.refcodes.eventbus.impls

Class AbstractEventBus<E extends Event<?>,O extends Observer<E>,EM extends EventMatcher<E>,H>

java.lang.Object

org.refcodes.eventbus.impls.AbstractEventBus<E,O,EM,H>

All Implemented Interfaces:

HandleLookup<H,O>, EventBusObservable<E,O,EM,H>, EventBusPublisher<E>, org.refcodes.matcher.Matcher<E>, EventMatcher<E>, Publisher<E>

Direct Known Subclasses:

EventBusImpl

public abstract class AbstractEventBus<E extends Event<?>,O extends Observer<E>,EM extends EventMatcher<E>,H>
extends Object
implements EventBusObservable<E,O,EM,H>, EventBusPublisher<E>

Constructor Summary

Constructors

Constructor and Description
AbstractEventBus(HandleGenerator<H> aHandleGenerator) Constructs the subscribe event bus with the given handle generator.

Method Summary

Modifier and Type	Method and Description
boolean	hasHandle(H aHandle)
boolean	isMatching(E aEvent) To avoid unnecessary event creation, a "sample" event which fits the desired event might be passed to this method in order to determine on whether to create an event which is to be published.
O	lookupHandle(H aHandle)
void	publishEvent(E aEvent)
O	removeHandle(H aHandle)
H	subscribe(O aObserver, EM aEventMatcher) Subscribes a listener to the event bus.
void	unsubscribeAll(O aObserver) Unsubscribes all registrations to a specific listener, even if that listener is involved in several subscriptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEventBus

public AbstractEventBus(HandleGenerator<H> aHandleGenerator)

Constructs the subscribe event bus with the given handle generator.

Parameters:

aHandleGenerator - The handle generator to be used.

Method Detail

publishEvent

public void publishEvent(E aEvent)

Specified by:

publishEvent in interface Publisher<E extends Event<?>>

isMatching

public boolean isMatching(E aEvent)

To avoid unnecessary event creation, a "sample" event which fits the desired event might be passed to this method in order to determine on whether to create an event which is to be published.

Specified by:

isMatching in interface org.refcodes.matcher.Matcher<E extends Event<?>>

Specified by:

isMatching in interface EventMatcher<E extends Event<?>>

subscribe

public H subscribe(O aObserver,
                   EM aEventMatcher)

Description copied from interface: EventBusObservable

Subscribes a listener to the event bus. In case the handle is being ignored, use the "unsubscribeAll" method where all subscriptions for a listener are removed.

Specified by:

subscribe in interface EventBusObservable<E extends Event<?>,O extends Observer<E>,EM extends EventMatcher<E>,H>

Parameters:

aObserver - The Observer to subscribe.

aEventMatcher - The EventMatcher to guard the Observer.

Returns:

A handle to unsubscribe this combination.

unsubscribeAll

public void unsubscribeAll(O aObserver)

Description copied from interface: EventBusObservable

Unsubscribes all registrations to a specific listener, even if that listener is involved in several subscriptions.

Specified by:

unsubscribeAll in interface EventBusObservable<E extends Event<?>,O extends Observer<E>,EM extends EventMatcher<E>,H>

hasHandle

public boolean hasHandle(H aHandle)

Specified by:

hasHandle in interface HandleLookup<H,O extends Observer<E>>

lookupHandle

public O lookupHandle(H aHandle)
               throws UnknownHandleRuntimeException

Specified by:

lookupHandle in interface HandleLookup<H,O extends Observer<E>>

Throws:

UnknownHandleRuntimeException

removeHandle

public O removeHandle(H aHandle)
               throws UnknownHandleRuntimeException

Specified by:

removeHandle in interface HandleLookup<H,O extends Observer<E>>

Throws:

UnknownHandleRuntimeException