Record Class BufferedPacket

java.lang.Object
java.lang.Record
net.minestom.server.network.packet.server.BufferedPacket
All Implemented Interfaces:
SendablePacket
@Internal public record BufferedPacket(NetworkBuffer buffer, long index, long length) extends Record implements SendablePacket
Represents a buffer to directly write to the network.

May contain multiple packets.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BufferedPacket(NetworkBuffer buffer, long index, long length)
    Creates an instance of a BufferedPacket record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    NetworkBuffer
    buffer()
    Returns the value of the buffer record component.
    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.
    long
    index()
    Returns the value of the index record component.
    long
    length()
    Returns the value of the length 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

    • BufferedPacket

      public BufferedPacket(NetworkBuffer buffer, long index, long length)
      Creates an instance of a BufferedPacket record class.
      Parameters:
      buffer - the value for the buffer record component
      index - the value for the index record component
      length - the value for the length 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 the compare method from their corresponding wrapper classes.
      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.

    • buffer

      public NetworkBuffer buffer()
      Returns the value of the buffer record component.
      Returns:
      the value of the buffer record component

    • index

      public long index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • length

      public long length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component