org.refcodes.eventbus

Class AbstractEventBus<E extends org.refcodes.observer.Event<?>,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.EventMatcher<E>,H>

java.lang.Object

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

Type Parameters:

E - the element type

O - the generic type

EM - the generic type

H - the generic type

All Implemented Interfaces:

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

Direct Known Subclasses:

EventBusImpl

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

The Class AbstractEventBus.

Constructor Summary

Constructors

Constructor and Description
AbstractEventBus(org.refcodes.component.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)
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(org.refcodes.component.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 org.refcodes.observer.Publisher<E extends org.refcodes.observer.Event<?>>

isMatching

public boolean isMatching(E aEvent)

Specified by:

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

Specified by:

isMatching in interface org.refcodes.observer.EventMatcher<E extends org.refcodes.observer.Event<?>>

subscribe

public H subscribe(O aObserver,
                   EM aEventMatcher)

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 org.refcodes.observer.Event<?>,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.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)

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

Specified by:

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

Parameters:

aObserver - the a observer

hasHandle

public boolean hasHandle(H aHandle)

Specified by:

hasHandle in interface org.refcodes.component.HandleLookup<H,O extends org.refcodes.observer.Observer<E>>

lookupHandle

public O lookupHandle(H aHandle)
               throws org.refcodes.component.UnknownHandleRuntimeException

Specified by:

lookupHandle in interface org.refcodes.component.HandleLookup<H,O extends org.refcodes.observer.Observer<E>>

Throws:

org.refcodes.component.UnknownHandleRuntimeException

removeHandle

public O removeHandle(H aHandle)
               throws org.refcodes.component.UnknownHandleRuntimeException

Specified by:

removeHandle in interface org.refcodes.component.HandleLookup<H,O extends org.refcodes.observer.Observer<E>>

Throws:

org.refcodes.component.UnknownHandleRuntimeException