Index
All Classes and Interfaces|All Packages
A
- accept(MessageContext<T>, T) - Method in interface dev.objz.commandbridge.api.message.MessageListener
-
Invoked when a message is received.
- accept(Platform.ServerTarget) - Method in interface dev.objz.commandbridge.api.message.ServerEventListener
-
Invoked when a server connects or disconnects.
- AUTH_FAILED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Authentication failed; no further attempts will be made.
- AUTHENTICATED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Fully connected and authorized to send/receive messages.
B
- backend(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform
- BACKEND - Enum constant in enum class dev.objz.commandbridge.api.platform.Platform
-
A backend Minecraft server (e.g.
C
- cancel() - Method in interface dev.objz.commandbridge.api.message.Subscription
-
Stops the listener from receiving further events.
- channel() - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Returns the value of the
channelrecord component. - channel(Class<T>) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
-
Obtains a
MessageChannelfor the given payload type. - ChannelPayload - Interface in dev.objz.commandbridge.api.channel
-
Marker interface for data sent over a
MessageChannel. - command() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Returns the value of the
commandrecord component. - CommandBridgeAPI - Interface in dev.objz.commandbridge.api
-
Main entry point for interacting with the CommandBridge network.
- CommandBridgeProvider - Class in dev.objz.commandbridge.api
-
Static provider for accessing the
CommandBridgeAPIinstance. - CommandPayload - Record Class in dev.objz.commandbridge.api.channel.command
-
Payload for command execution.
- CommandPayload(String, RunAs) - Constructor for record class dev.objz.commandbridge.api.channel.command.CommandPayload
- CommandPayload(String, RunAs, UUID) - Constructor for record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Creates an instance of a
CommandPayloadrecord class. - CONNECTED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Socket connected, awaiting authentication.
- connectedServers() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
- CONNECTING - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Attempting to establish a socket connection.
- connectionState() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
- ConnectionState - Enum Class in dev.objz.commandbridge.api.platform
-
Represents the network connection status between a server and the bridge.
- CONSOLE - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs
-
Run as the server console.
D
- dev.objz.commandbridge.api - package dev.objz.commandbridge.api
- dev.objz.commandbridge.api.channel - package dev.objz.commandbridge.api.channel
- dev.objz.commandbridge.api.channel.command - package dev.objz.commandbridge.api.channel.command
- dev.objz.commandbridge.api.message - package dev.objz.commandbridge.api.message
- dev.objz.commandbridge.api.platform - package dev.objz.commandbridge.api.platform
- DISCONNECTED - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
No connection established.
E
- equals(Object) - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Indicates whether some other object is "equal to" this one.
F
- from() - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Returns the value of the
fromrecord component.
G
- get() - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider
- get(Class<T>) - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider
-
Obtains the API instance cast to a specific type.
H
- hashCode() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Returns a hash code value for this object.
I
- id() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Returns the value of the
idrecord component. - isActive() - Method in enum class dev.objz.commandbridge.api.platform.ConnectionState
L
- listen(MessageListener<P>) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel
-
Subscribes a listener to messages received on this channel.
- locate(UUID) - Method in interface dev.objz.commandbridge.api.platform.PlayerLocator
-
Resolves the server target for a player UUID.
M
- MessageChannel<P> - Interface in dev.objz.commandbridge.api.channel
-
Communication pipe for sending and receiving
ChannelPayloads. - MessageChannel.Sender<P> - Interface in dev.objz.commandbridge.api.channel
-
A target-bound sender for dispatching payloads.
- MessageContext<T> - Record Class in dev.objz.commandbridge.api.message
-
Metadata for a received message.
- MessageContext(Class<T>, Platform.ServerTarget, long) - Constructor for record class dev.objz.commandbridge.api.message.MessageContext
-
Creates an instance of a
MessageContextrecord class. - MessageListener<T> - Interface in dev.objz.commandbridge.api.message
-
Handles incoming messages for a specific channel.
O
- onConnectionStateChanged(Consumer<ConnectionState>) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
-
Subscribes to connection state changes.
- onServerConnected(ServerEventListener) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
-
Subscribes to server connection events.
- onServerDisconnected(ServerEventListener) - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
-
Subscribes to server disconnection events.
- OPERATOR - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs
-
Run as a player with temporary operator permissions.
P
- Platform - Enum Class in dev.objz.commandbridge.api.platform
-
Enumeration of supported bridge platforms.
- Platform.ServerTarget - Record Class in dev.objz.commandbridge.api.platform
-
Identifies a specific server in the bridge network.
- player() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Returns the value of the
playerrecord component. - PLAYER - Enum constant in enum class dev.objz.commandbridge.api.channel.command.RunAs
-
Run as a specific player.
- playerLocator() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
- PlayerLocator - Interface in dev.objz.commandbridge.api.platform
-
Service for finding which server a player is currently connected to.
R
- RECONNECTING - Enum constant in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Connection lost, attempting to re-establish.
- register(CommandBridgeAPI) - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider
-
Registers the API implementation.
- request(P) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
-
Sends a request and waits for a response with the default timeout.
- request(P, Duration) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
-
Sends a request and waits for a response with a custom timeout.
- requirePlayer() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
- requirePlayer(UUID) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
- runAs() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Returns the value of the
runAsrecord component. - RunAs - Enum Class in dev.objz.commandbridge.api.channel.command
-
Defines the execution context for a command.
S
- send(P) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
-
Sends a payload without expecting a response.
- server() - Method in interface dev.objz.commandbridge.api.CommandBridgeAPI
- ServerEventListener - Interface in dev.objz.commandbridge.api.message
-
Listener for server lifecycle events in the bridge network.
- ServerTarget(String, Platform) - Constructor for record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Creates an instance of a
ServerTargetrecord class. - Subscription - Interface in dev.objz.commandbridge.api.message
-
A handle to a registered listener that can be cancelled.
T
- target(String) - Method in enum class dev.objz.commandbridge.api.platform.Platform
-
Creates a
Platform.ServerTargetfor this platform. - timestamp() - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Returns the value of the
timestamprecord component. - to(Collection<Platform.ServerTarget>) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel
-
Targets one or more servers for sending.
- toAll() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel
-
Targets all connected servers for sending.
- toString() - Method in record class dev.objz.commandbridge.api.channel.command.CommandPayload
-
Returns a string representation of this record class.
- toString() - Method in record class dev.objz.commandbridge.api.message.MessageContext
-
Returns a string representation of this record class.
- toString() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Returns a string representation of this record class.
- type() - Method in record class dev.objz.commandbridge.api.platform.Platform.ServerTarget
-
Returns the value of the
typerecord component.
U
- unregister() - Static method in class dev.objz.commandbridge.api.CommandBridgeProvider
-
Unregisters the current API implementation.
V
- valueOf(String) - Static method in enum class dev.objz.commandbridge.api.channel.command.RunAs
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.objz.commandbridge.api.channel.command.RunAs
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.objz.commandbridge.api.platform.ConnectionState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class dev.objz.commandbridge.api.platform.Platform
-
Returns an array containing the constants of this enum class, in the order they are declared.
- velocity(String) - Static method in enum class dev.objz.commandbridge.api.platform.Platform
- VELOCITY - Enum constant in enum class dev.objz.commandbridge.api.platform.Platform
-
The Velocity proxy.
W
- whenOnline() - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
- whenOnline(UUID) - Method in interface dev.objz.commandbridge.api.channel.MessageChannel.Sender
All Classes and Interfaces|All Packages