Index
All Classes and Interfaces|All Packages
A
- add(T) - Method in class me.tamkungz.signals.connection.ConnectionGroup
-
Tracks a connection.
- all(Connection...) - Static method in interface me.tamkungz.signals.connection.Connection
-
Combines several connections so they can be disconnected together.
B
- bus() - Method in class me.tamkungz.signals.geb.GebBridge
-
Returns the underlying GEB bus.
- bus() - Method in class me.tamkungz.signals.Signal
-
Returns the bus this signal lives on.
C
- cast(Object) - Method in class me.tamkungz.signals.SignalKey
-
Casts a value to this key's payload type.
- clear() - Method in class me.tamkungz.signals.internal.SignalRouter
-
Disconnects every listener of every key.
- clear() - Method in class me.tamkungz.signals.Signal
-
Disconnects every listener of this signal's channel, including ones connected through other
Signalinstances for the same key. - clear() - Method in class me.tamkungz.signals.SignalBus
-
Disconnects every listener of every channel on this bus.
- clear(Class) - Method in class me.tamkungz.signals.SignalBus
-
Disconnects every listener of the default channel of a payload type.
- clear(SignalKey) - Method in class me.tamkungz.signals.internal.SignalRouter
-
Disconnects every listener of a key.
- clear(SignalKey) - Method in class me.tamkungz.signals.SignalBus
-
Disconnects every listener of a channel.
- close() - Method in interface me.tamkungz.signals.connection.Connection
-
Alias of
Connection.disconnect(). - connect(Class, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to the default channel of a payload type.
- connect(Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a listener.
- connect(ConnectionGroup, Class, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to the default channel of a payload type and tracks it in a group.
- connect(ConnectionGroup, Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a listener and tracks it in a group.
- connect(ConnectionGroup, SignalKey, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to a channel and tracks it in a group.
- connect(SignalKey, Consumer) - Method in class me.tamkungz.signals.internal.SignalRouter
-
Registers a listener for a key.
- connect(SignalKey, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to a channel.
- connectIf(Predicate, Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a listener that only receives the values a predicate accepts.
- connectIf(ConnectionGroup, Predicate, Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a filtered listener and tracks it in a group.
- Connection - Interface in me.tamkungz.signals.connection
-
Handle for a registered listener or bus registration.
- ConnectionGroup - Class in me.tamkungz.signals.connection
-
Tracks many connections and disconnects them all at once, for example when a plugin disables.
- ConnectionGroup() - Constructor for class me.tamkungz.signals.connection.ConnectionGroup
- create() - Static method in class me.tamkungz.signals.connection.ConnectionGroup
-
Creates an empty group.
- create() - Static method in class me.tamkungz.signals.SignalBus
-
Creates a bus on top of a new GEB instance.
D
- disconnect() - Method in interface me.tamkungz.signals.connection.Connection
-
Stops this connection from receiving further values.
- disconnect() - Method in class me.tamkungz.signals.connection.ConnectionGroup
-
Disconnects every tracked connection and stops accepting new ones.
- disconnected() - Static method in interface me.tamkungz.signals.connection.Connection
-
Returns a connection that is already disconnected.
E
- equals(Object) - Method in class me.tamkungz.signals.SignalKey
- eventType() - Method in class me.tamkungz.signals.internal.SignalEnvelope
-
Returns the payload type.
- eventType() - Method in class me.tamkungz.signals.Signal
-
Returns the payload type of this signal.
- eventType() - Method in class me.tamkungz.signals.SignalKey
-
Returns the payload type, with primitives boxed.
F
- filter(Predicate) - Method in class me.tamkungz.signals.Signal
-
Returns a new signal that only carries the values a predicate accepts.
- fire(Class, T) - Method in class me.tamkungz.signals.SignalBus
-
Fires a value on the default channel of a payload type.
- fire(SignalKey, T) - Method in class me.tamkungz.signals.SignalBus
-
Fires a value on a channel.
- fire(T) - Method in class me.tamkungz.signals.Signal
-
Delivers a value to every listener of this signal, on the calling thread.
G
- geb() - Method in class me.tamkungz.signals.SignalBus
-
Gives direct access to GEB: custom events,
@Listenlisteners and sub-buses. - GebBridge - Class in me.tamkungz.signals.geb
- GebBridge(IBus) - Constructor for class me.tamkungz.signals.geb.GebBridge
-
Wraps a GEB bus.
H
- hashCode() - Method in class me.tamkungz.signals.SignalKey
I
- isConnected() - Method in interface me.tamkungz.signals.connection.Connection
-
Tells whether this connection is still active.
- isConnected() - Method in class me.tamkungz.signals.connection.ConnectionGroup
- isRegistered(IBus) - Method in class me.tamkungz.signals.geb.GebBridge
-
Tells whether a sub-bus is registered.
- isRegistered(IListener) - Method in class me.tamkungz.signals.geb.GebBridge
-
Tells whether a listener is registered.
K
- key() - Method in class me.tamkungz.signals.internal.SignalEnvelope
-
Returns the key the payload is fired on.
- key() - Method in class me.tamkungz.signals.Signal
-
Returns the key of this signal's channel.
L
- listen(IListener) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a listener and returns a connection that unregisters it.
- listen(ConnectionGroup, IListener) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a listener and tracks its connection in a group.
- listenerCount() - Method in class me.tamkungz.signals.Signal
-
Counts the listeners connected to this signal's channel.
- listenerCount(Class) - Method in class me.tamkungz.signals.SignalBus
-
Counts the listeners connected to the default channel of a payload type.
- listenerCount(SignalKey) - Method in class me.tamkungz.signals.internal.SignalRouter
-
Counts the listeners connected to a key.
- listenerCount(SignalKey) - Method in class me.tamkungz.signals.SignalBus
-
Counts the listeners connected to a channel.
M
- map(Class, Function) - Method in class me.tamkungz.signals.Signal
-
Returns a new signal that carries every value of this signal converted by a function.
- me.tamkungz.signals - package me.tamkungz.signals
- me.tamkungz.signals.connection - package me.tamkungz.signals.connection
-
Connection handles and groups used to disconnect listeners.
- me.tamkungz.signals.geb - package me.tamkungz.signals.geb
-
Direct GEB access for custom events,
@Listenlisteners and sub-buses. - me.tamkungz.signals.internal - package me.tamkungz.signals.internal
-
Implementation details of the signal bus.
N
- name() - Method in class me.tamkungz.signals.SignalKey
-
Returns the channel name.
- named(Class, String) - Static method in class me.tamkungz.signals.SignalKey
-
Returns the key of a named channel for a payload type.
O
- of(Class) - Static method in class me.tamkungz.signals.SignalKey
-
Returns the default key of a payload type, the same as
named(eventType, "default"). - of(Connection...) - Static method in class me.tamkungz.signals.connection.ConnectionGroup
-
Creates a group that tracks the given connections.
- once(Class, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to the default channel of a payload type that is disconnected after its first value.
- once(Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a listener that is disconnected after its first value.
- once(ConnectionGroup, Class, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a one-shot listener to the default channel of a payload type and tracks it in a group.
- once(ConnectionGroup, Consumer) - Method in class me.tamkungz.signals.Signal
-
Connects a one-shot listener and tracks it in a group.
- once(ConnectionGroup, SignalKey, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a one-shot listener to a channel and tracks it in a group.
- once(SignalKey, Consumer) - Method in class me.tamkungz.signals.internal.SignalRouter
-
Registers a listener that is disconnected after its first value.
- once(SignalKey, Consumer) - Method in class me.tamkungz.signals.SignalBus
-
Connects a listener to a channel that is disconnected after its first value.
- onSignal(SignalEnvelope) - Method in class me.tamkungz.signals.internal.SignalRouter
-
GEB entry point: delivers an envelope to the listeners of its key.
P
- post(IEvent) - Method in class me.tamkungz.signals.geb.GebBridge
-
Posts an event to every registered listener.
R
- registerListener(IListener) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a listener.
- registerSubBus(IBus, int) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a sub-bus.
S
- signal(Class) - Method in class me.tamkungz.signals.SignalBus
-
Returns the signal on the default channel of a payload type.
- signal(Class, String) - Method in class me.tamkungz.signals.SignalBus
-
Returns the signal on a named channel of a payload type.
- signal(SignalKey) - Method in class me.tamkungz.signals.SignalBus
-
Returns the signal on a channel.
- Signal<T> - Class in me.tamkungz.signals
-
Lightweight signal facade for a single payload type.
- SignalBus - Class in me.tamkungz.signals
-
Minecraft-friendly facade over GEB.
- SignalBus() - Constructor for class me.tamkungz.signals.SignalBus
-
Creates a bus on top of a new GEB instance.
- SignalBus(IBus) - Constructor for class me.tamkungz.signals.SignalBus
-
Creates a bus on top of an existing GEB bus.
- SignalEnvelope<T> - Class in me.tamkungz.signals.internal
-
GEB event that carries one signal payload together with the key it was fired on.
- SignalEnvelope(Class, T) - Constructor for class me.tamkungz.signals.internal.SignalEnvelope
-
Wraps a payload for the default key of its type.
- SignalEnvelope(SignalKey, T) - Constructor for class me.tamkungz.signals.internal.SignalEnvelope
-
Wraps a payload for the given key.
- SignalKey<T> - Class in me.tamkungz.signals
-
Identifies one signal channel: a payload type plus a name.
- SignalRouter - Class in me.tamkungz.signals.internal
-
Routes
SignalEnvelopes arriving from GEB to the listeners registered for their key. - SignalRouter() - Constructor for class me.tamkungz.signals.internal.SignalRouter
- size() - Method in class me.tamkungz.signals.connection.ConnectionGroup
-
Returns how many connections the group currently tracks.
- subBus(IBus, int) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a sub-bus and returns a connection that unregisters it.
- subBus(ConnectionGroup, IBus, int) - Method in class me.tamkungz.signals.geb.GebBridge
-
Registers a sub-bus and tracks its connection in a group.
T
- toString() - Method in class me.tamkungz.signals.SignalKey
U
- unregisterListener(IListener) - Method in class me.tamkungz.signals.geb.GebBridge
-
Unregisters a listener.
- unregisterSubBus(IBus) - Method in class me.tamkungz.signals.geb.GebBridge
-
Unregisters a sub-bus.
V
- value() - Method in class me.tamkungz.signals.internal.SignalEnvelope
-
Returns the payload.
All Classes and Interfaces|All Packages