Package dev.jorel.commandapi.network.packets

Record Class ProtocolVersionTooOldPacket

java.lang.Object

java.lang.Record

dev.jorel.commandapi.network.packets.ProtocolVersionTooOldPacket

Record Components:

protocolVersion - The CommandAPIProtocol.PROTOCOL_VERSION to send in this packet.

reason - The reason why this packet is being sent.

All Implemented Interfaces:

CommandAPIPacket

public record ProtocolVersionTooOldPacket(int protocolVersion, String reason)
extends Record
implements CommandAPIPacket

A packet that informs a connected instance of the CommandAPI their CommandAPIProtocol.PROTOCOL_VERSION is too old to receive a different packet this instance wanted to send.

This packet may be sent in any direction. It is automatically sent whenever a ProtocolVersionTooOldException is thrown while writing another packet. When received, a ProtocolVersionTooOldException should be thrown on the receiving side that mimics the original exception.

Constructor Summary

Constructors

Constructor	Description
ProtocolVersionTooOldPacket(int protocolVersion, String reason)	Creates an instance of a ProtocolVersionTooOldPacket record class.

Method Summary

Modifier and Type	Method	Description
static ProtocolVersionTooOldPacket	deserialize(FriendlyByteBuffer buffer)	Reads the bytes from the given FriendlyByteBuffer to create a new ProtocolVersionTooOldPacket.
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.
int	protocolVersion()	Returns the value of the protocolVersion record component.
String	reason()	Returns the value of the reason record component.
final String	toString()	Returns a string representation of this record class.
void	write(FriendlyByteBuffer buffer, Object target, int protocolVersion)	Writes the data of this packet to a FriendlyByteBuffer.

Methods inherited from class java.lang.Object

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

Constructor Details

ProtocolVersionTooOldPacket

public ProtocolVersionTooOldPacket(int protocolVersion,
 String reason)

Creates an instance of a ProtocolVersionTooOldPacket record class.

Parameters:

protocolVersion - the value for the protocolVersion record component

reason - the value for the reason record component

Method Details

deserialize

public static ProtocolVersionTooOldPacket deserialize(FriendlyByteBuffer buffer)

Reads the bytes from the given FriendlyByteBuffer to create a new ProtocolVersionTooOldPacket.

Parameters:

buffer - The buffer to read bytes from.

Returns:

The ProtocolVersionTooOldPacket sent to this plugin.

write

public void write(FriendlyByteBuffer buffer,
 Object target,
 int protocolVersion)

Description copied from interface: CommandAPIPacket

Writes the data of this packet to a FriendlyByteBuffer.

Specified by:

write in interface CommandAPIPacket

Parameters:

buffer - The byte buffer to write to.

target - The OutputChannel this packet is being sent to.

protocolVersion - The CommandAPIProtocol.PROTOCOL_VERSION of the CommandAPI instance this packet is being sent to. Implementations of this method should make sure not to send any data the receiving instance can not understand. If this packet simply cannot be sent to the receiving version, it is appropriate to throw an ProtocolVersionTooOldException.

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.

protocolVersion

public int protocolVersion()

Returns the value of the protocolVersion record component.

Returns:

the value of the protocolVersion record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component