Package dev.objz.commandbridge.api.message

Record Class MessageContext<T extends ChannelPayload>

java.lang.Object

java.lang.Record

dev.objz.commandbridge.api.message.MessageContext<T>

Type Parameters:

T - the payload type of the channel this message was received on; bounded by ChannelPayload

Record Components:

channel - the Class token of the payload type, identifying which channel this message was received on

from - the Platform.ServerTarget identifying the server that sent the message

timestamp - the time at which the message was sent, in milliseconds since the Unix epoch

public record MessageContext<T extends ChannelPayload>(Class<T extends ChannelPayload> channel, Platform.ServerTarget from, long timestamp)
extends Record

Metadata accompanying a message received on a MessageChannel.

channel is the payload class token identifying the channel the message arrived on. from identifies the server that sent the message. timestamp is the Unix epoch millisecond value when the message was sent.

See Also:

• MessageListener

Constructor Summary

Constructors

Constructor	Description
MessageContext(Class<T> channel, Platform.ServerTarget from, long timestamp)	Creates an instance of a MessageContext record class.

Method Summary

Modifier and Type	Method	Description
Class<T>	channel()	Returns the value of the channel record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Platform.ServerTarget	from()	Returns the value of the from record component.
final int	hashCode()	Returns a hash code value for this object.
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

MessageContext

public MessageContext(Class<T> channel,
 Platform.ServerTarget from,
 long timestamp)

Creates an instance of a MessageContext record class.

Parameters:

channel - the value for the channel record component

from - the value for the from record component

timestamp - the value for the timestamp record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

channel

public Class<T> channel()

Returns the value of the channel record component.

Returns:

the value of the channel record component

from

public Platform.ServerTarget from()

Returns the value of the from record component.

Returns:

the value of the from record component

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component