Java API
class

GebBridge

me.tamkungz.signals.geb.GebBridge

Version
0.2.1-SNAPSHOT
Java
21
Source file
me/tamkungz/signals/geb/GebBridge.java
Repository
View source ↗

Direct access to the GEB bus behind a {@link me.tamkungz.signals.SignalBus}: custom

{@link IEvent}s, {@code @Listen} listeners and sub-buses.

<p>

Obtain it with {@link me.tamkungz.signals.SignalBus#geb()}.

public final class GebBridge

Constructors 1

GebBridge

public GebBridge(IBus bus)

Wraps a GEB bus.

@param
bus bus to expose

Methods 16

bus

public IBus bus()

Returns the underlying GEB bus.

@return
the raw bus

post

public boolean post(IEvent event)

Posts an event to every registered listener.

@param
event event to post
@return
{@code false} if the event was cancelled, {@code true} otherwise

listen

public Connection listen(IListener listener)

Registers a listener and returns a connection that unregisters it.

@param
listener listener to register
@return
connection that unregisters the listener

disconnect

@Override public void disconnect()

isConnected

@Override public boolean isConnected()

listen

public Connection listen(ConnectionGroup group, IListener listener)

Registers a listener and tracks its connection in a group.

@param
group group that will disconnect the listener
@param
listener listener to register
@return
connection that unregisters the listener

registerListener

public void registerListener(IListener listener)

Registers a listener.

@param
listener listener to register

unregisterListener

public void unregisterListener(IListener listener)

Unregisters a listener.

@param
listener listener to unregister

isRegistered

public boolean isRegistered(IListener listener)

Tells whether a listener is registered.

@param
listener listener to check
@return
{@code true} if registered

subBus

public Connection subBus(IBus subBus, int priority)

Registers a sub-bus and returns a connection that unregisters it.

@param
subBus bus to forward events to
@param
priority sub-bus priority
@return
connection that unregisters the sub-bus

disconnect

@Override public void disconnect()

isConnected

@Override public boolean isConnected()

subBus

public Connection subBus(ConnectionGroup group, IBus subBus, int priority)

Registers a sub-bus and tracks its connection in a group.

@param
group group that will unregister the sub-bus
@param
subBus bus to forward events to
@param
priority sub-bus priority
@return
connection that unregisters the sub-bus

registerSubBus

public void registerSubBus(IBus subBus, int priority)

Registers a sub-bus.

@param
subBus bus to forward events to
@param
priority sub-bus priority

unregisterSubBus

public void unregisterSubBus(IBus subBus)

Unregisters a sub-bus.

@param
subBus bus to stop forwarding to

isRegistered

public boolean isRegistered(IBus subBus)

Tells whether a sub-bus is registered.

@param
subBus bus to check
@return
{@code true} if registered