Package net.neoforged.neoforge.network.negotiation

Record Class NegotiableNetworkComponent

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.negotiation.NegotiableNetworkComponent
Record Components:
id - The id of the payload type.
version - The version of the payload type.
flow - The flow of the payload type.
optional - Whether the payload type is optional.
@Internal public record NegotiableNetworkComponent(ResourceLocation id, Optional<String> version, Optional<PacketFlow> flow, boolean optional) extends Record
Represents the input to the negotiation process for a single network payload type.

  • Field Details

    • id

      private final ResourceLocation id
      The field for the id record component.

    • version

      private final Optional<String> version
      The field for the version record component.

    • flow

      private final Optional<PacketFlow> flow
      The field for the flow record component.

    • optional

      private final boolean optional
      The field for the optional record component.

  • Constructor Details

    • NegotiableNetworkComponent

      public NegotiableNetworkComponent(ResourceLocation id, Optional<String> version, Optional<PacketFlow> flow, boolean optional)
      Creates an instance of a NegotiableNetworkComponent record class.
      Parameters:
      id - the value for the id record component
      version - the value for the version record component
      flow - the value for the flow record component
      optional - the value for the optional 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.

    • id

      public ResourceLocation id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • version

      public Optional<String> version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component

    • flow

      public Optional<PacketFlow> flow()
      Returns the value of the flow record component.
      Returns:
      the value of the flow record component

    • optional

      public boolean optional()
      Returns the value of the optional record component.
      Returns:
      the value of the optional record component