Package net.fabricmc.fabric.api.transfer.v1.storage.base

Record Class ResourceAmount<T>

java.lang.Object
java.lang.Record
net.fabricmc.fabric.api.transfer.v1.storage.base.ResourceAmount<T>
Type Parameters:
T - The type of the stored resource. Experimental feature, we reserve the right to remove or change it without further notice. The transfer API is a complex addition, and we want to be able to correct possible design mistakes.
@Experimental public record ResourceAmount<T>(T resource, long amount) extends Record
An immutable object storing both a resource and an amount, provided for convenience.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResourceAmount(T resource, long amount)
    Creates an instance of a ResourceAmount record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    amount()
    Returns the value of the amount 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.
    T
    resource()
    Returns the value of the resource record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ResourceAmount

      public ResourceAmount(T resource, long amount)
      Creates an instance of a ResourceAmount record class.
      Parameters:
      resource - the value for the resource record component
      amount - the value for the amount 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.

    • resource

      public T resource()
      Returns the value of the resource record component.
      Returns:
      the value of the resource record component

    • amount

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