Record Class PlayerMessage

java.lang.Object

java.lang.Record

dev.ua.theroer.magicutils.platform.PlayerMessage

Record Components:

playerId - stable player id when available

playerName - current player display/login name

message - raw chat content or raw command line

type - source message type

public record PlayerMessage(UUID playerId, String playerName, String message, PlayerMessageType type)
extends Record

Normalized player-originated message emitted by the platform layer.

Constructor Summary

Constructors

Constructor	Description
PlayerMessage(UUID playerId, String playerName, String message, PlayerMessageType type)	Creates an instance of a PlayerMessage 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.
boolean	isValid()	Returns true when the payload contains enough data to process safely.
String	message()	Returns the value of the message record component.
UUID	playerId()	Returns the value of the playerId record component.
String	playerName()	Returns the value of the playerName record component.
final String	toString()	Returns a string representation of this record class.
PlayerMessageType	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

PlayerMessage

public PlayerMessage(UUID playerId,
 String playerName,
 String message,
 PlayerMessageType type)

Creates an instance of a PlayerMessage record class.

Parameters:

playerId - the value for the playerId record component

playerName - the value for the playerName record component

message - the value for the message record component

type - the value for the type record component

Method Details

isValid

public boolean isValid()

Returns true when the payload contains enough data to process safely.

Returns:

true for non-empty player name and message

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.

playerId

public UUID playerId()

Returns the value of the playerId record component.

Returns:

the value of the playerId record component

playerName

public String playerName()

Returns the value of the playerName record component.

Returns:

the value of the playerName record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

type

public PlayerMessageType type()

Returns the value of the type record component.

Returns:

the value of the type record component