Module org.refcodes.eventbus
Package org.refcodes.eventbus
Interface EventBusObservable<E extends org.refcodes.observer.GenericEvent<?>,O extends org.refcodes.observer.Observer<E>,MATCH extends org.refcodes.observer.EventMatcher<E>,H>
-
- Type Parameters:
E
- the element typeO
- the generic typeMATCH
- the generic typeH
- the generic type
- All Superinterfaces:
org.refcodes.component.HandleLookup<H,O>
- All Known Subinterfaces:
EventBus
,GenericEventBus<E,O,MATCH,META,H>
- All Known Implementing Classes:
AbstractEventBus
,EventBusImpl
public interface EventBusObservable<E extends org.refcodes.observer.GenericEvent<?>,O extends org.refcodes.observer.Observer<E>,MATCH extends org.refcodes.observer.EventMatcher<E>,H> extends org.refcodes.component.HandleLookup<H,O>
TheObservable
part of theGenericEventBus
provides means to registerObserver
instances.In case your
EventBusObservable
notifies upon events of typeMetaDataActionEvent
, you may use theMetaDataActionEventImpl
and an action for distinguishing your various types of notification:TIPP: In order to distinguish
MetaDataActionEventImpl
instances from each other, create an actions enumeration, enumerating the various event actions you support. Pass the actual action you intend to notify upon to the according constructor, as anObserver
you may use the declarative methodEventMatcherSugar.actionEqualWith(Object)
to test whether your action was notified (or a simple switch case statement).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <EVT extends E>
Hsubscribe(Class<EVT> aEventType, MATCH aEventMatcher, org.refcodes.observer.Observer<EVT> aObserver)
Subscribes a listener to the event bus.<EVT extends E>
Hsubscribe(Class<EVT> aEventType, org.refcodes.observer.Observer<EVT> aObserver)
Subscribes a listener to the event bus.H
subscribe(MATCH aEventMatcher, O aObserver)
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.
-
-
-
Method Detail
-
subscribe
H subscribe(MATCH aEventMatcher, O aObserver)
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.- Parameters:
aEventMatcher
- TheEventMatcher
to guard theObserver
.aObserver
- TheObserver
to subscribe.- Returns:
- A handle to unsubscribe this combination.
-
subscribe
<EVT extends E> H subscribe(Class<EVT> aEventType, org.refcodes.observer.Observer<EVT> aObserver)
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.- Type Parameters:
EVT
- The type of the event to subscribe for.- Parameters:
aEventType
- The type of event to observe.aObserver
- TheObserver
to subscribe.- Returns:
- A handle to unsubscribe this combination.
-
subscribe
<EVT extends E> H subscribe(Class<EVT> aEventType, MATCH aEventMatcher, org.refcodes.observer.Observer<EVT> aObserver)
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.- Type Parameters:
EVT
- The type of the event to subscribe for.- Parameters:
aEventType
- The type of event to observe.aEventMatcher
- TheEventMatcher
to guard theObserver
.aObserver
- TheObserver
to subscribe.- Returns:
- A handle to unsubscribe this combination.
-
unsubscribeAll
void unsubscribeAll(O aObserver)
Unsubscribes all registrations to a specific listener, even if that listener is involved in several subscriptions.- Parameters:
aObserver
- the observer
-
-