Package com.btcvelocity.api.bridge

Record Class BridgeMessage.QueueJoin

java.lang.Object

java.lang.Record

com.btcvelocity.api.bridge.BridgeMessage.QueueJoin

Record Components:

uuid - the player's unique id

username - the player's username

targetServer - the name of the server the player queued for

targetWorld - an optional world the player intends to join, may be null

All Implemented Interfaces:

BridgeMessage

Enclosing interface:

BridgeMessage

public static record BridgeMessage.QueueJoin(UUID uuid, String username, String targetServer, @Nullable String targetWorld)
extends Record
implements BridgeMessage

Proxy -> Backend: a player joined the queue for a server.

Nested Class Summary

Nested classes/interfaces inherited from interface com.btcvelocity.api.bridge.BridgeMessage

BridgeMessage.ConnectRequest, BridgeMessage.Health, BridgeMessage.PartyWarp, BridgeMessage.QueueJoin, BridgeMessage.QueueLeave, BridgeMessage.QueueStatusResponse, BridgeMessage.RequestStatus, BridgeMessage.WorldLoaded, BridgeMessage.WorldPreload, BridgeMessage.WorldUnloaded

Constructor Summary

Constructors

Constructor	Description
QueueJoin(UUID uuid, String username, String targetServer, @Nullable String targetWorld)	Creates an instance of a QueueJoin record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	targetServer()	Returns the value of the targetServer record component.
@Nullable String	targetWorld()	Returns the value of the targetWorld record component.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the string discriminator used to route this message during (de)serialization.
String	username()	Returns the value of the username record component.
UUID	uuid()	Returns the value of the uuid record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueueJoin

public QueueJoin(UUID uuid,
 String username,
 String targetServer,
 @Nullable
 @Nullable String targetWorld)

Creates an instance of a QueueJoin record class.

Parameters:

uuid - the value for the uuid record component

username - the value for the username record component

targetServer - the value for the targetServer record component

targetWorld - the value for the targetWorld record component

Method Details

type

public String type()

Description copied from interface: BridgeMessage

Returns the string discriminator used to route this message during (de)serialization.

Specified by:

type in interface BridgeMessage

Returns:

the message type identifier

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

uuid

public UUID uuid()

Returns the value of the uuid record component.

Returns:

the value of the uuid record component

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

targetServer

public String targetServer()

Returns the value of the targetServer record component.

Returns:

the value of the targetServer record component

targetWorld

@Nullable
public @Nullable String targetWorld()

Returns the value of the targetWorld record component.

Returns:

the value of the targetWorld record component