Record Class NetworkComponentNegotiator.ComponentNegotiationResult

java.lang.Object
java.lang.Record
net.neoforged.neoforge.network.negotiation.NetworkComponentNegotiator.ComponentNegotiationResult
Record Components:
success - If negotiation succeeded.
failureReason - The reason for failure if negotiation failed.
Enclosing class:
NetworkComponentNegotiator
public static record NetworkComponentNegotiator.ComponentNegotiationResult(boolean success, @Nullable Component failureReason) extends Record
The result of a negotiation.

  • Field Details

    • success

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

    • failureReason

      private final @Nullable Component failureReason
      The field for the failureReason record component.

  • Constructor Details

    • ComponentNegotiationResult

      public ComponentNegotiationResult(boolean success, @Nullable Component failureReason)
      Creates an instance of a ComponentNegotiationResult record class.
      Parameters:
      success - the value for the success record component
      failureReason - the value for the failureReason 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.

    • success

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

    • failureReason

      public @Nullable Component failureReason()
      Returns the value of the failureReason record component.
      Returns:
      the value of the failureReason record component