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.
    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.
    boolean
    post(foo.zaaarf.geb.api.IEvent event)
    Posts an event to every registered listener.
    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
    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

    • listen

      public Connection listen(foo.zaaarf.geb.api.IListener listener)
      Registers a listener and returns a connection that unregisters it.
      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