Record Class NetworkChannelsPacketSplitter

java.lang.Object
java.lang.Record
eu.cloudnetservice.driver.impl.network.chunk.splitter.NetworkChannelsPacketSplitter
All Implemented Interfaces:
Consumer<eu.cloudnetservice.driver.network.protocol.Packet>
public record NetworkChannelsPacketSplitter(@NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel> channels) extends Record implements Consumer<eu.cloudnetservice.driver.network.protocol.Packet>
A default implementation of a chunked packet splitter, splitting each packet chunk to multiple channels.
Since:
4.0

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final @NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel>
    channels
    The field for the channels record component.

  • Constructor Summary

    Constructors
    Constructor
    Description
    NetworkChannelsPacketSplitter(@NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel> channels)
    Creates an instance of a NetworkChannelsPacketSplitter record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(@NonNull eu.cloudnetservice.driver.network.protocol.Packet packet)
    Sends the given packet safely to all listening components of the chunked data transfer.
    @NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel>
    channels()
    Returns the value of the channels 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.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

    Methods inherited from interface Consumer

    andThen

  • Field Details

    • channels

      @NonNull private final @NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel> channels
      The field for the channels record component.

  • Constructor Details

    • NetworkChannelsPacketSplitter

      public NetworkChannelsPacketSplitter(@NonNull @NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel> channels)
      Creates an instance of a NetworkChannelsPacketSplitter record class.
      Parameters:
      channels - the value for the channels record component

  • Method Details

    • accept

      public void accept(@NonNull @NonNull eu.cloudnetservice.driver.network.protocol.Packet packet)
      Sends the given packet safely to all listening components of the chunked data transfer.
      Specified by:
      accept in interface Consumer<eu.cloudnetservice.driver.network.protocol.Packet>
      Parameters:
      packet - the packet to send.
      Throws:
      NullPointerException - if the given packet is null.

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

    • channels

      @NonNull public @NonNull Collection<eu.cloudnetservice.driver.network.NetworkChannel> channels()
      Returns the value of the channels record component.
      Returns:
      the value of the channels record component