Package net.neoforged.neoforge.transfer.resource

Record Class ResourceStack<T extends Resource>

java.lang.Object
java.lang.Record
net.neoforged.neoforge.transfer.resource.ResourceStack<T>
Record Components:
resource - The resource to wrap the stack around.
amount - The amount of the resource the stack is holding.
public record ResourceStack<T extends Resource>(T extends Resource resource, int amount) extends Record
Creates a resource stack from a given resource and amount.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    amount
    The field for the amount record component.
    private final T
    resource
    The field for the resource record component.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    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.
    boolean
    isEmpty()
    Checks if the resource stack is empty, meaning that the amount is zero or that the resource is empty.
    T
    resource()
    Returns the value of the resource record component.
    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

  • Field Details

    • resource

      private final T extends Resource resource
      The field for the resource record component.

    • amount

      private final int amount
      The field for the amount record component.

  • Constructor Details

    • ResourceStack

      public ResourceStack(T resource, int amount)
      Creates an instance of a ResourceStack record class.
      Parameters:
      resource - the value for the resource record component
      amount - the value for the amount record component

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Checks if the resource stack is empty, meaning that the amount is zero or that the resource is empty.
      Returns:
      true if empty

    • toString

      public 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 int amount()
      Returns the value of the amount record component.
      Returns:
      the value of the amount record component