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

Interface PropertiesBus

All Superinterfaces:
org.refcodes.eventbus.DispatchStrategyAccessor, org.refcodes.eventbus.EventBusObservable<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationBusEventMatcher,String>, org.refcodes.eventbus.EventBusPublisher<ApplicationBusEvent>, org.refcodes.eventbus.EventDispatcher<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationBusEventMatcher,org.refcodes.observer.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 PropertiesBus extends org.refcodes.eventbus.EventDispatcher<ApplicationBusEvent,org.refcodes.observer.Observer<ApplicationBusEvent>,ApplicationBusEventMatcher,org.refcodes.observer.EventMetaData,String>
The PropertiesBus extends the ApplicationBus with convenience functionality common to everyday application and service development regarding dispatching of Properties 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
    onProperties(Class<?> aPublisherType, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(Enum<?> aAction, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(String aChannel, org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances with the given attributes.
    default String
    onProperties(org.refcodes.observer.Observer<PropertiesBusEvent> aObserver)
    Similar to the more generic method EventBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PropertiesBusEvent instances.
    default PropertiesBusEvent.Builder
    publishProperties()
    Fires an event with the properties set for the PropertiesBusEvent.Builder instance upon finishing of by invoking PropertiesBusEvent.Builder.build().
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, Class<?> aPublisherType)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aChannel)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
    Publishes an event with the provided properties for the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default PropertiesBusEvent.Builder
    publishProperties(org.refcodes.eventbus.DispatchStrategy aStrategy)
    Fires an event with the properties set for the PropertiesBusEvent.Builder instance upon finishing of by invoking PropertiesBusEvent.Builder.build().
    default void
    publishProperties(org.refcodes.properties.Properties aProperties)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, Class<?> aPublisherType)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, String aChannel)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData)
    Publishes an event with the provided properties and the given attributes.
    default void
    publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
    Publishes an event with the provided properties 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.EventDispatcher

    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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • onProperties

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

    • publishProperties

      default PropertiesBusEvent.Builder publishProperties()
      Fires an event with the properties set for the PropertiesBusEvent.Builder instance upon finishing of by invoking PropertiesBusEvent.Builder.build().
      Returns:
      The PropertiesBusEvent class' builder.

    • publishProperties

      default PropertiesBusEvent.Builder publishProperties(org.refcodes.eventbus.DispatchStrategy aStrategy)
      Fires an event with the properties set for the PropertiesBusEvent.Builder instance upon finishing of by invoking PropertiesBusEvent.Builder.build().
      Parameters:
      aStrategy - The DispatchStrategy to use when dispatching the event.
      Returns:
      The PropertiesBusEvent class' builder.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which the event represents.
      aProperties - The properties to be carried by the event.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, Class<?> aPublisherType)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which this represents.
      aProperties - The properties to be carried by the event.
      aPublisherType - The type of the event publisher.

    • publishProperties

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

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which the event represents.
      aProperties - The properties to be carried by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which the event represents.
      aProperties - The properties to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which the event represents.
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aChannel)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which this represents.
      aProperties - The properties to be carried by the event.
      aChannel - The channel name on which the event is receivable.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which this represents.
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes an event with the provided properties for the given attributes.
      Parameters:
      aAction - The action which this represents.
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(Enum<?> aAction, org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aAction - The action which this represents.
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, Class<?> aPublisherType)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.
      aPublisherType - The type of the event publisher.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.
      aPublisherType - The type of the event publisher.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.
      aStrategy - The DispatchStrategy to use when dispatching the event.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.
      aEventMetaData - The Meta-Data to by supplied by the event.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, org.refcodes.observer.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, String aChannel)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties to be carried by the event.
      aChannel - The channel name on which the event is receivable.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties 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.

    • publishProperties

      default void publishProperties(org.refcodes.properties.Properties aProperties, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes an event with the provided properties and the given attributes.
      Parameters:
      aProperties - The properties 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.