Class GebBridge

java.lang.Object
me.tamkungz.signals.geb.GebBridge
public final class GebBridge extends Object
Direct access to the GEB bus behind a SignalBus: custom IEvents, @Listen listeners and sub-buses.

Obtain it with SignalBus.geb().

  • Constructor Summary

    Constructors
    Constructor
    Description
    GebBridge(foo.zaaarf.geb.api.IBus bus)
    Wraps a GEB bus.

  • Method Summary

    Modifier and Type
    Method
    Description
    foo.zaaarf.geb.api.IBus
    bus()
    Returns the underlying GEB bus.
    Connection
    dispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
    Registers a dispatcher and returns a connection that unregisters it.
    Connection
    dispatcher(ConnectionGroup group, foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
    Registers a dispatcher and tracks its connection in a group.
    boolean
    hasSubBuses()
    Tells whether any sub-bus is registered through this bridge.
    boolean
    isRegistered(foo.zaaarf.geb.api.IBus subBus)
    Tells whether a sub-bus is registered.
    boolean
    isRegistered(foo.zaaarf.geb.api.IListener listener)
    Tells whether a listener is registered.
    Connection
    listen(foo.zaaarf.geb.api.IListener listener)
    Registers a listener and returns a connection that unregisters it.
    Connection
    listen(ConnectionGroup group, foo.zaaarf.geb.api.IListener listener)
    Registers a listener and tracks its connection in a group.
    void
    loadAndRegisterDispatchers(ClassLoader classLoader)
    Registers every dispatcher a class loader lists in META-INF/services/foo.zaaarf.geb.api.IEventDispatcher, the file GEB's annotation processor writes.
    Connection
    loadDispatchers(ClassLoader classLoader)
    Registers every dispatcher a class loader lists in META-INF/services/foo.zaaarf.geb.api.IEventDispatcher and returns one connection that unregisters all of them.
    Connection
    loadDispatchers(ConnectionGroup group, ClassLoader classLoader)
    Registers the dispatchers of a class loader and tracks their connection in a group.
    boolean
    post(foo.zaaarf.geb.api.IEvent event)
    Posts an event to every registered listener.
    void
    registerDispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
    Registers the dispatcher of an event type.
    void
    registerListener(foo.zaaarf.geb.api.IListener listener)
    Registers a listener.
    void
    registerSubBus(foo.zaaarf.geb.api.IBus subBus, int priority)
    Registers a sub-bus.
    Connection
    subBus(foo.zaaarf.geb.api.IBus subBus, int priority)
    Registers a sub-bus and returns a connection that unregisters it.
    Connection
    subBus(ConnectionGroup group, foo.zaaarf.geb.api.IBus subBus, int priority)
    Registers a sub-bus and tracks its connection in a group.
    void
    unregisterDispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
    Unregisters the dispatcher of an event type; its listeners stop being called.
    void
    unregisterListener(foo.zaaarf.geb.api.IListener listener)
    Unregisters a listener.
    void
    unregisterSubBus(foo.zaaarf.geb.api.IBus subBus)
    Unregisters a sub-bus.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GebBridge

      public GebBridge(foo.zaaarf.geb.api.IBus bus)
      Wraps a GEB bus.
      Parameters:
      bus - bus to expose

  • Method Details

    • bus

      public foo.zaaarf.geb.api.IBus bus()
      Returns the underlying GEB bus.
      Returns:
      the raw bus

    • post

      public boolean post(foo.zaaarf.geb.api.IEvent event)
      Posts an event to every registered listener.
      Parameters:
      event - event to post
      Returns:
      false if the event was cancelled, true otherwise

    • registerDispatcher

      public void registerDispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
      Registers the dispatcher of an event type.

      GEB only calls the listeners of an event type once its dispatcher is registered on the bus, and drops events that have none without any warning. Dispatchers are generated by GEB's annotation processor for classes with @Listen methods.

      A bus keeps one dispatcher per event type: registering a dispatcher replaces the one registered earlier for the same event type. To undo a registration later, prefer dispatcher(IEventDispatcher), which returns a connection that does it.

      Parameters:
      dispatcher - dispatcher to register

    • unregisterDispatcher

      public void unregisterDispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
      Unregisters the dispatcher of an event type; its listeners stop being called.

      Only the very same dispatcher instance is removed: if another one has replaced it for that event type in the meantime, nothing happens.

      Parameters:
      dispatcher - dispatcher to unregister

    • dispatcher

      public Connection dispatcher(foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
      Registers a dispatcher and returns a connection that unregisters it.

      Disconnecting removes the dispatcher only if it is still the one registered for its event type; see unregisterDispatcher(IEventDispatcher). This is how a plugin that registers dispatchers on a bus that outlives it (such as the shared bus) cleans up after itself.

      Parameters:
      dispatcher - dispatcher to register
      Returns:
      connection that unregisters the dispatcher

    • dispatcher

      public Connection dispatcher(ConnectionGroup group, foo.zaaarf.geb.api.IEventDispatcher<?> dispatcher)
      Registers a dispatcher and tracks its connection in a group.
      Parameters:
      group - group that will unregister the dispatcher
      dispatcher - dispatcher to register
      Returns:
      connection that unregisters the dispatcher

    • loadAndRegisterDispatchers

      public void loadAndRegisterDispatchers(ClassLoader classLoader)
      Registers every dispatcher a class loader lists in META-INF/services/foo.zaaarf.geb.api.IEventDispatcher, the file GEB's annotation processor writes.

      Pass the class loader of the plugin that defines the @Listen methods, for example getClass().getClassLoader() in the plugin's main class. The dispatchers stay registered until the bus is gone; use loadDispatchers(ClassLoader) to be able to unregister them.

      Parameters:
      classLoader - class loader to read the service file from

    • loadDispatchers

      public Connection loadDispatchers(ClassLoader classLoader)
      Registers every dispatcher a class loader lists in META-INF/services/foo.zaaarf.geb.api.IEventDispatcher and returns one connection that unregisters all of them.

      Disconnect it when your plugin disables: a bus that outlives the plugin (the shared bus does) would otherwise keep the plugin's dispatchers, and with them its class loader, alive after a reload.

      It is all or nothing: if the service file is broken, the dispatchers registered up to that point are unregistered again before the failure is rethrown.

      Parameters:
      classLoader - class loader to read the service file from
      Returns:
      connection that unregisters every dispatcher this call registered
      Throws:
      ServiceConfigurationError - if the service file lists a class that cannot be loaded or instantiated

    • loadDispatchers

      public Connection loadDispatchers(ConnectionGroup group, ClassLoader classLoader)
      Registers the dispatchers of a class loader and tracks their connection in a group.
      Parameters:
      group - group that will unregister the dispatchers
      classLoader - class loader to read the service file from
      Returns:
      connection that unregisters every dispatcher this call registered
      See Also:

    • listen

      public Connection listen(foo.zaaarf.geb.api.IListener listener)
      Registers a listener and returns a connection that unregisters it.

      The listener is only called for event types whose dispatcher is registered, see registerDispatcher(IEventDispatcher).

      Parameters:
      listener - listener to register
      Returns:
      connection that unregisters the listener

    • listen

      public Connection listen(ConnectionGroup group, foo.zaaarf.geb.api.IListener listener)
      Registers a listener and tracks its connection in a group.
      Parameters:
      group - group that will disconnect the listener
      listener - listener to register
      Returns:
      connection that unregisters the listener

    • registerListener

      public void registerListener(foo.zaaarf.geb.api.IListener listener)
      Registers a listener.
      Parameters:
      listener - listener to register

    • unregisterListener

      public void unregisterListener(foo.zaaarf.geb.api.IListener listener)
      Unregisters a listener.
      Parameters:
      listener - listener to unregister

    • isRegistered

      public boolean isRegistered(foo.zaaarf.geb.api.IListener listener)
      Tells whether a listener is registered.
      Parameters:
      listener - listener to check
      Returns:
      true if registered

    • subBus

      public Connection subBus(foo.zaaarf.geb.api.IBus subBus, int priority)
      Registers a sub-bus and returns a connection that unregisters it.
      Parameters:
      subBus - bus to forward events to
      priority - sub-bus priority
      Returns:
      connection that unregisters the sub-bus

    • subBus

      public Connection subBus(ConnectionGroup group, foo.zaaarf.geb.api.IBus subBus, int priority)
      Registers a sub-bus and tracks its connection in a group.
      Parameters:
      group - group that will unregister the sub-bus
      subBus - bus to forward events to
      priority - sub-bus priority
      Returns:
      connection that unregisters the sub-bus

    • registerSubBus

      public void registerSubBus(foo.zaaarf.geb.api.IBus subBus, int priority)
      Registers a sub-bus.
      Parameters:
      subBus - bus to forward events to
      priority - sub-bus priority

    • unregisterSubBus

      public void unregisterSubBus(foo.zaaarf.geb.api.IBus subBus)
      Unregisters a sub-bus.
      Parameters:
      subBus - bus to stop forwarding to

    • isRegistered

      public boolean isRegistered(foo.zaaarf.geb.api.IBus subBus)
      Tells whether a sub-bus is registered.
      Parameters:
      subBus - bus to check
      Returns:
      true if registered

    • hasSubBuses

      public boolean hasSubBuses()
      Tells whether any sub-bus is registered through this bridge.

      Everything fired on this bus is forwarded to its sub-buses, and what they do with it cannot be inspected. A sub-bus registered directly on the raw bus() instead of through this bridge is not seen here.

      Returns:
      true if at least one sub-bus is registered