Interface PauseBus

    • 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

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default String onPause​(Class<?> aPublisherType, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(Enum<?> aAction, Class<?> aPublisherType, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(Enum<?> aAction, String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(Enum<?> aAction, String aChannel, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(Enum<?> aAction, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(String aChannel, org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
      default String onPause​(org.refcodes.observer.Observer<PauseBusEvent> aObserver)
      Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances.
      default void publishPause​()
      Publishes a pause event with the given attributes.
      default void publishPause​(Class<?> aPublisherType)
      Publishes a pause event with the given attributes.
      default void publishPause​(Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a pause event with the given attributes.
      default void publishPause​(String aChannel)
      Publishes a pause event with the given attributes.
      default void publishPause​(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType)
      Publishes an event with the provided initialize for the given attributes.
      default void publishPause​(String aAlias, String aGroup, String aChannel, String aUid, Class<?> aPublisherType, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a pause event with the given attributes.
      default void publishPause​(String aChannel, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a pause event with the given attributes.
      default void publishPause​(org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a pause event with the given attributes.
      default void publishPause​(org.refcodes.mixin.EventMetaData aEventMetaData)
      Publishes a pause event with the given attributes.
      default void publishPause​(org.refcodes.mixin.EventMetaData aEventMetaData, org.refcodes.eventbus.DispatchStrategy aStrategy)
      Publishes a pause event with the given attributes.
      • Methods inherited from interface org.refcodes.eventbus.DispatchStrategyAccessor

        getDispatchStrategy
      • Methods inherited from interface org.refcodes.observer.EventMatcher

        isMatching
      • Methods inherited from interface org.refcodes.eventbus.GenericBusObservable

        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
    • Method Detail

      • publishPause

        default void publishPause​(Class<?> aPublisherType)
        Publishes a pause event with the given attributes. This method uses the DispatchStrategy.CASCADE to make sure your publishing thread synchronizes till all observers have been notified, though your publishing thread is not blocked upon event publishing of the observers (also using the default DispatchStrategy.CASCADE) themselves.
        Parameters:
        aPublisherType - The type of the event publisher.
      • publishPause

        default void publishPause​(String aChannel)
        Publishes a pause event with the given attributes. This method uses the DispatchStrategy.CASCADE to make sure your publishing thread synchronizes till all observers have been notified, though your publishing thread is not blocked upon event publishing of the observers (also using the default DispatchStrategy.CASCADE) themselves.
        Parameters:
        aChannel - The channel name on which the event is receivable.
      • publishPause

        default void publishPause​(String aAlias,
                                  String aGroup,
                                  String aChannel,
                                  String aUid,
                                  Class<?> aPublisherType)
        Publishes an event with the provided initialize for the given attributes. This method uses the DispatchStrategy.CASCADE to make sure your publishing thread synchronizes till all observers have been notified, though your publishing thread is not blocked upon event publishing of the observers (also using the default DispatchStrategy.CASCADE) themselves.
        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.
      • publishPause

        default void publishPause​(org.refcodes.mixin.EventMetaData aEventMetaData)
        Publishes a pause event with the given attributes. This method uses the DispatchStrategy.CASCADE to make sure your publishing thread synchronizes till all observers have been notified, though your publishing thread is not blocked upon event publishing of the observers (also using the default DispatchStrategy.CASCADE) themselves.
        Parameters:
        aEventMetaData - The Meta-Data to by supplied by the event.
      • publishPause

        default void publishPause​()
        Publishes a pause event with the given attributes. This method uses the DispatchStrategy.CASCADE to make sure your publishing thread synchronizes till all observers have been notified, though your publishing thread is not blocked upon event publishing of the observers (also using the default DispatchStrategy.CASCADE) themselves.
      • publishPause

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

        default void publishPause​(String aChannel,
                                  org.refcodes.eventbus.DispatchStrategy aStrategy)
        Publishes a pause 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.
      • publishPause

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

        default void publishPause​(org.refcodes.mixin.EventMetaData aEventMetaData,
                                  org.refcodes.eventbus.DispatchStrategy aStrategy)
        Publishes a pause 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.
      • publishPause

        default void publishPause​(org.refcodes.eventbus.DispatchStrategy aStrategy)
        Publishes a pause event with the given attributes.
        Parameters:
        aStrategy - The DispatchStrategy to use when dispatching the event.
      • onPause

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

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

        default String onPause​(String aChannel,
                               org.refcodes.observer.Observer<PauseBusEvent> aObserver)
        Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent 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.
      • onPause

        default String onPause​(String aAlias,
                               String aGroup,
                               String aChannel,
                               String aUid,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<PauseBusEvent> aObserver)
        Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent instances with the given attributes.
        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.
      • onPause

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

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

        default String onPause​(Enum<?> aAction,
                               String aAlias,
                               String aGroup,
                               String aChannel,
                               String aUid,
                               Class<?> aPublisherType,
                               org.refcodes.observer.Observer<PauseBusEvent> aObserver)
        Similar to the more generic method GenericBusObservable.subscribe(EventMatcher, Observer) THOUGH subscribes for PauseBusEvent 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-ID) property.
        aPublisherType - The type of the event publisher.
        aObserver - The observer to be notified.
        Returns:
        A handle to unsubscribe this combination.
      • onPause

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