org.refcodes.eventbus.impls

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

java.lang.Object

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

Type Parameters:

E - The event type

OD - The event listener descriptor type

H - The handle type

All Implemented Interfaces:

org.refcodes.component.HandleLookup<H,O>, EventBusObservable<E,O,EM,H>

public class EventBusObservableImpl<E extends org.refcodes.observer.events.Event,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.EventMatcher<E>,H>
extends Object
implements EventBusObservable<E,O,EM,H>

This delegate hides any additional functionality away from a caller concerning the the provides implementation.

Author:

steiner

Constructor Summary

Constructors

Constructor and Description
EventBusObservableImpl(EventBusObservable<E,O,EM,H> aSubscribeEventBus) Constructs a delegate for a subscribe event bus.

Method Summary

Modifier and Type	Method and Description
boolean	hasHandle(H aHandle)
O	lookupHandle(H aHandle)
O	removeHandle(H aHandle)
H	subscribe(O aObserver, EM aEventMatcher) Subscribes a listener to the event bus.
void	unsubscribeAll(O aEventListener) 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

EventBusObservableImpl

public EventBusObservableImpl(EventBusObservable<E,O,EM,H> aSubscribeEventBus)

Constructs a delegate for a subscribe event bus.

Parameters:

aSubscribeEventBus - The publish event bus to hide away.

Method Detail

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.events.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 aEventListener)

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.events.Event,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.EventMatcher<E>,H>

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.traps.UnknownHandleRuntimeException

Specified by:

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

Throws:

org.refcodes.component.traps.UnknownHandleRuntimeException

removeHandle

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

Specified by:

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

Throws:

org.refcodes.component.traps.UnknownHandleRuntimeException