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

Interface StartBus

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 Subinterfaces:
LifecycleBus
All Known Implementing Classes:
ApplicationBus
public interface StartBus extends org.refcodes.eventbus.GenericEventBus<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationEventMatcher,org.refcodes.mixin.EventMetaData,String>
The StartBus extends the ApplicationBus with convenience functionality common to everyday application and service development regarding dispatching of StartBusEvent instances.

  • 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
    onStart(Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(Enum<?> aAction, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(String aChannel, org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances with the given attributes.
    default String
    onStart(org.refcodes.observer.Observer<StartBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent instances.
    default void
    publishStart()
    Publishes a start event with the given attributes.
    default void
    publishStart(Class<?> aPublisherType)
    Publishes a start event with the given attributes.
    default void
    publishStart(Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes a start event with the given attributes.
    default void
    publishStart(String aChannel)
    Publishes a start event with the given attributes.
    default void
    publishStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
    Publishes a start event with the given attributes.
    default void
    publishStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes a start event with the given attributes.
    default void
    publishStart(String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes a start event with the given attributes.
    default void
    publishStart(org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes a start event with the given attributes.
    default void
    publishStart(org.refcodes.mixin.EventMetaData aEventMetaData)
    Publishes a start event with the given attributes.
    default void
    publishStart(org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes a start event with 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

    • publishStart

      default void publishStart(Class<?> aPublisherType)
      Publishes a start event with the given attributes. This method uses the DispatchStrategy.PARALLEL as we assume all observers already being initialized.
      Parameters:
      aPublisherType - The type of the event publisher.

    • publishStart

      default void publishStart(String aChannel)
      Publishes a start event with the given attributes. This method uses the DispatchStrategy.PARALLEL as we assume all observers already being initialized.
      Parameters:
      aChannel - The channel name on which the event is receivable.

    • publishStart

      default void publishStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes a start event with the given attributes. This method uses the DispatchStrategy.PARALLEL as we assume all observers already being initialized.
      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.

    • publishStart

      default void publishStart(org.refcodes.mixin.EventMetaData aEventMetaData)
      Publishes a start event with the given attributes. This method uses the DispatchStrategy.PARALLEL as we assume all observers already being initialized.
      Parameters:
      aEventMetaData - The Meta-Data to by supplied by the event.

    • publishStart

      default void publishStart()
      Publishes a start event with the given attributes. This method uses the DispatchStrategy.PARALLEL as we assume all observers already being initialized.

    • publishStart

      default void publishStart(Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a start event with the given attributes.
      Parameters:
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishStart

      default void publishStart(String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a start event with the given attributes.
      Parameters:
      aChannel - The channel name on which the event is receivable.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishStart

      default void publishStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a start event 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.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishStart

      default void publishStart(org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a start event with the given attributes.
      Parameters:
      aEventMetaData - The Meta-Data to by supplied by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishStart

      default void publishStart(org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a start event with the given attributes.
      Parameters:
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • onStart

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

    • onStart

      default String onStart(Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(String aChannel, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.

    • onStart

      default String onStart(Enum<?> aAction, org.refcodes.observer.Observer<StartBusEvent> aObserver)
      Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for StartBusEvent 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.