org.refcodes.eventbus

Interface GenericEventBus<E extends org.refcodes.observer.GenericEvent<?>,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.EventMatcher<E>,H>

Type Parameters:

E - the element type

O - the generic type

EM - the generic type

H - the generic type

All Superinterfaces:

BusObservable<E,O,EM,H>, BusPublisher<E>, DispatchStrategyAccessor, org.refcodes.observer.EventMatcher<E>, org.refcodes.component.HandleLookup<H,O>, org.refcodes.matcher.Matcher<E>, org.refcodes.observer.Publisher<E>

All Known Subinterfaces:

EventBus

All Known Implementing Classes:

AbstractEventBus, EventBusImpl

public interface GenericEventBus<E extends org.refcodes.observer.GenericEvent<?>,O extends org.refcodes.observer.Observer<E>,EM extends org.refcodes.observer.EventMatcher<E>,H>
extends BusPublisher<E>, BusObservable<E,O,EM,H>, DispatchStrategyAccessor

The GenericEventBus is the (virtual) machine wide manager for GenericActionEvent handling.

TIPP: In order to distinguish ActionMetaDataEventImpl 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 an Observer you may use the declarative method EventMatcherSugar.actionEqualWith(Object) to test whether your action was notified (or a simple switch case statement).

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

DispatchStrategyAccessor.DispatchStrategyMutator, DispatchStrategyAccessor.DispatchStrategyProperty

Method Summary

Modifier and Type	Method and Description
<EVT extends E> String	onAction(Class<EVT> aEventType, Enum<?> aAction, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given action.
String	onAction(Enum<?> aAction, O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given action.
String	onCatchAll(O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes all events passing the Event-Bus.
<EVT extends E> String	onChannel(Class<EVT> aEventType, String aChannel, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given channel.
String	onChannel(String aChannel, O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given channel.
String	onEvent(Class<?> aPublisherType, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, Class<?> aPublisherType, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, Enum<?> aAction, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, String aChannel, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onEvent(Class<EVT> aEventType, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(Enum<?> aAction, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(String aChannel, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
String	onEvent(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<BusEvent> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes.
<EVT extends E> String	onGroup(Class<EVT> aEventType, String aGroup, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given group.
String	onGroup(String aGroup, O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given group.
<EVT extends E> String	onName(Class<EVT> aEventType, String aName, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given name.
String	onName(String aName, O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given name.
<EVT extends E> String	onType(Class<EVT> aEventType, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events of the given type.
<EVT extends E> String	onUniversalId(Class<EVT> aEventType, String aUid, org.refcodes.observer.Observer<EVT> aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given Universal-ID.
String	onUniversalId(String aUid, O aObserver) Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given Universal-ID.
default void	publishEvent(E aEvent) Publishes an event using the DispatchStrategy as returned by DispatchStrategyAccessor.getDispatchStrategy().
void	publishEvent(E aEvent, DispatchStrategy aDispatchStrategy) Publishes an event using the given DispatchStrategy.

Methods inherited from interface org.refcodes.observer.EventMatcher

isMatching

Methods inherited from interface org.refcodes.eventbus.BusObservable

subscribe, subscribe, unsubscribeAll

Methods inherited from interface org.refcodes.component.HandleLookup

hasHandle, lookupHandle, removeHandle

Methods inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

getDispatchStrategy

Method Detail

publishEvent

default void publishEvent(E aEvent)

Publishes an event using the DispatchStrategy as returned by DispatchStrategyAccessor.getDispatchStrategy().

Specified by:

publishEvent in interface org.refcodes.observer.Publisher<E extends org.refcodes.observer.GenericEvent<?>>

publishEvent

void publishEvent(E aEvent,
                  DispatchStrategy aDispatchStrategy)

Publishes an event using the given DispatchStrategy.

Parameters:

aEvent - aEvent The event to be published.

aDispatchStrategy - The DispatchStrategy to be used when publishing the event.

onEvent

String onEvent(Class<?> aPublisherType,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(String aChannel,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(String aAlias,
               String aGroup,
               String aChannel,
               String aUid,
               Class<?> aPublisherType,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-ID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(Enum<?> aAction,
               Class<?> aPublisherType,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aAction - The action which this represents.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(Enum<?> aAction,
               String aChannel,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aAction - The action which this represents.

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(Enum<?> aAction,
               String aAlias,
               String aGroup,
               String aChannel,
               String aUid,
               Class<?> aPublisherType,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aAction - The action which this represents.

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-ID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

String onEvent(Enum<?> aAction,
               org.refcodes.observer.Observer<BusEvent> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aAction - The action which this represents.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onName

String onName(String aName,
              O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given name.

Parameters:

aName - The name for which to subscribe.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onChannel

String onChannel(String aChannel,
                 O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given channel.

Parameters:

aChannel - The name channel to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onGroup

String onGroup(String aGroup,
               O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given group.

Parameters:

aGroup - The name group to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onUniversalId

String onUniversalId(String aUid,
                     O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given Universal-ID.

Parameters:

aUid - The name Universal-ID to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onAction

String onAction(Enum<?> aAction,
                O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given action.

Parameters:

aAction - The name action to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onCatchAll

String onCatchAll(O aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes all events passing the Event-Bus. Call it a "catch-all" hook.

Parameters:

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               String aChannel,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               String aAlias,
                               String aGroup,
                               String aChannel,
                               String aUid,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-ID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               Enum<?> aAction,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aAction - The action which this represents.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               Enum<?> aAction,
                               String aChannel,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aAction - The action which this represents.

aChannel - The channel name on which the event is receivable.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               Enum<?> aAction,
                               String aAlias,
                               String aGroup,
                               String aChannel,
                               String aUid,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aAction - The action which this represents.

aAlias - The alias property.

aGroup - The group property.

aChannel - The channel property.

aUid - The UID (Universal-ID) property.

aPublisherType - The type of the event publisher.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onEvent

<EVT extends E> String onEvent(Class<EVT> aEventType,
                               Enum<?> aAction,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given attributes. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aAction - The action which this represents.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onType

<EVT extends E> String onType(Class<EVT> aEventType,
                              org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events of the given type. Your Observable may be of the required type!

Parameters:

aEventType - The event type to subscribe for.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onName

<EVT extends E> String onName(Class<EVT> aEventType,
                              String aName,
                              org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events with the given name.

Parameters:

aEventType - The event type to subscribe for.

aName - The name for which to subscribe.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onChannel

<EVT extends E> String onChannel(Class<EVT> aEventType,
                                 String aChannel,
                                 org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given channel.

Parameters:

aEventType - The event type to subscribe for.

aChannel - The name channel to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onGroup

<EVT extends E> String onGroup(Class<EVT> aEventType,
                               String aGroup,
                               org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given group.

Parameters:

aEventType - The event type to subscribe for.

aGroup - The name group to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onUniversalId

<EVT extends E> String onUniversalId(Class<EVT> aEventType,
                                     String aUid,
                                     org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given Universal-ID.

Parameters:

aEventType - The event type to subscribe for.

aUid - The name Universal-ID to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.

onAction

<EVT extends E> String onAction(Class<EVT> aEventType,
                                Enum<?> aAction,
                                org.refcodes.observer.Observer<EVT> aObserver)

Similar to the more generic method BusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for events for the given action.

Parameters:

aEventType - The event type to subscribe for.

aAction - The name action to which to subscribe to.

aObserver - The observer to be notified.

Returns:

A handle to unsubscribe this combination.