Record Class ResourceStack

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.resource.ResourceStack
public record ResourceStack(@NotNull ResourceVariant variant, long amount) extends Record
An immutable amount of a ResourceVariant. The amount is never negative.

  • Constructor Details

    • ResourceStack

      public ResourceStack(@NotNull @NotNull ResourceVariant variant, long amount)
      Creates an instance of a ResourceStack record class.
      Parameters:
      variant - the value for the variant record component
      amount - the value for the amount record component

  • Method Details

    • of

      @NotNull public static @NotNull ResourceStack of(@NotNull @NotNull ResourceType type, long amount)

    • type

      @NotNull public @NotNull ResourceType type()

    • isEmpty

      public boolean isEmpty()

    • withAmount

      @NotNull public @NotNull ResourceStack withAmount(long amount)

    • toString

      @NotNull public @NotNull 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.

    • variant

      @NotNull public @NotNull ResourceVariant variant()
      Returns the value of the variant record component.
      Returns:
      the value of the variant record component

    • amount

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