Module org.refcodes.eventbus.ext.application
Package org.refcodes.eventbus.ext.application

Interface PayloadBus

All Superinterfaces:
org.refcodes.eventbus.DispatchStrategyAccessor, org.refcodes.eventbus.EventBusObservable<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,String>, org.refcodes.eventbus.EventBusPublisher<ApplicationBusEvent>, org.refcodes.eventbus.GenericEventBus<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,org.refcodes.mixin.EventMetaData,String>, org.refcodes.component.HandleLookup<String,org.refcodes.observer.Observer<ApplicationBusEvent>>, org.refcodes.matcher.Matchable<ApplicationBusEvent>, org.refcodes.observer.Publisher<ApplicationBusEvent>
All Known Implementing Classes:
ApplicationBus
public interface PayloadBus extends org.refcodes.eventbus.GenericEventBus<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,org.refcodes.mixin.EventMetaData,String>
The PayloadBus extends the ApplicationBus with convenience functionality common to everyday application and service development regarding dispatching of payloads.

  • Nested Class Summary

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

    org.refcodes.eventbus.DispatchStrategyAccessor.DispatchStrategyMutator, org.refcodes.eventbus.DispatchStrategyAccessor.DispatchStrategyProperty

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    onPayload(Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(Enum<?> aAction, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
    default String
    onPayload(org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, Class<?> aPublisherType)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, String aChannel)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(Enum<?> aAction, P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, Class<?> aPublisherType)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, String aChannel)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData)
    Publishes an event with the provided payload and the given attributes.
    default <P> void
    publishPayload(P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided payload and the given attributes.

    Methods inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

    getDispatchStrategy

    Methods inherited from interface org.refcodes.eventbus.EventBusObservable

    subscribe, subscribe, subscribe, unsubscribeAll

    Methods inherited from interface org.refcodes.eventbus.GenericEventBus

    onAction, onAction, onActions, onActions, onAlias, onAlias, onCatchAll, onChannel, onChannel, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onEvent, onGroup, onGroup, onType, onUniversalId, onUniversalId, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent, publishEvent

    Methods inherited from interface org.refcodes.component.HandleLookup

    hasHandle, lookupHandle, removeHandle

    Methods inherited from interface org.refcodes.matcher.Matchable

    isMatching

  • Method Details

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, Class<?> aPublisherType)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aPublisherType - The type of the event publisher.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, String aChannel)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aChannel - The channel name on which the event is receivable.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which the event represents.
      aPayload - The payload to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which the event represents.
      aPayload - The payload to be carried by the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, Class<?> aPublisherType)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aPublisherType - The type of the event publisher.

    • publishPayload

      default <P> void publishPayload(P aPayload, String aChannel)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aChannel - The channel name on which the event is receivable.

    • publishPayload

      default <P> void publishPayload(P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.

    • publishPayload

      default <P> void publishPayload(P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.

    • publishPayload

      default <P> void publishPayload(P aPayload)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aChannel - The channel name on which the event is receivable.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which this represents.
      aPayload - The payload to be carried by the event.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which the event represents.
      aPayload - The payload to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(Enum<?> aAction, P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aAction - The action which the event represents.
      aPayload - The payload to be carried by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aChannel - The channel name on which the event is receivable.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishPayload

      default <P> void publishPayload(P aPayload, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided payload and the given attributes.
      Type Parameters:
      P - The type of the payload to carry.
      Parameters:
      aPayload - The payload to be carried by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • onPayload

      default String onPayload(org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances.
      Parameters:
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aPublisherType - The type of the event publisher.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aChannel - The channel name on which the event is receivable.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aAction - The action property.
      aPublisherType - The type of the event publisher.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aAction - The action property.
      aChannel - The channel name on which the event is receivable.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes.
      Parameters:
      aAction - The action property.
      aAlias - The alias property.
      aGroup - The group property.
      aChannel - The channel property.
      aUid - The UID (Universal-TID) property.
      aPublisherType - The type of the event publisher.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.

    • onPayload

      default String onPayload(Enum<?> aAction, org.refcodes.observer.Observer<PayloadBusEvent<?>> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PayloadBusEvent instances with the given attributes. Your Observable may be of the required type!
      Parameters:
      aAction - The action property.
      aObserver - The observer to be notified.
      Returns:
      A handle to unsubscribe this combination.