Record Class PacketReading.Result.Success<T>

java.lang.Object

java.lang.Record

net.minestom.server.network.packet.PacketReading.Result.Success<T>

All Implemented Interfaces:

PacketReading.Result<T>

Enclosing interface:

PacketReading.Result<T>

public static record PacketReading.Result.Success<T>(List<PacketReading.ParsedPacket<T>> packets)
extends Record
implements PacketReading.Result<T>

At least one packet was read. The buffer may still contain half-read packets and should therefore be compacted for next read.

Nested Class Summary

Nested classes/interfaces inherited from interface PacketReading.Result

PacketReading.Result.Empty<T>, PacketReading.Result.Failure<T>, PacketReading.Result.Success<T>

Constructor Summary

Constructors

Constructor	Description
Success(List<PacketReading.ParsedPacket<T>> packets)	Creates an instance of a Success record class.
Success(PacketReading.ParsedPacket<T> packet)

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.
List<PacketReading.ParsedPacket<T>>	packets()	Returns the value of the packets record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Success

public Success(List<PacketReading.ParsedPacket<T>> packets)

Creates an instance of a Success record class.

Parameters:

packets - the value for the packets record component

Success

public Success(PacketReading.ParsedPacket<T> packet)

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. 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.

packets

public List<PacketReading.ParsedPacket<T>> packets()

Returns the value of the packets record component.

Returns:

the value of the packets record component