Record Class InventoryItem

java.lang.Object
java.lang.Record
com.botwithus.bot.api.snapshot.InventoryItem
Record Components:
slot - slot index within the parent Inventory
itemId - item definition id, or -1 for an empty slot
quantity - stack size; 0 when isEmpty()
public record InventoryItem(int slot, int itemId, int quantity) extends Record
One slot of an inventory snapshot.

  • Constructor Summary

    Constructors
    Constructor
    Description
    InventoryItem(int slot, int itemId, int quantity)
    Creates an instance of a InventoryItem record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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()
     
    int
    itemId()
    Returns the value of the itemId record component.
    int
    quantity()
    Returns the value of the quantity record component.
    int
    slot()
    Returns the value of the slot record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • InventoryItem

      public InventoryItem(int slot, int itemId, int quantity)
      Creates an instance of a InventoryItem record class.
      Parameters:
      slot - the value for the slot record component
      itemId - the value for the itemId record component
      quantity - the value for the quantity record component

  • Method Details

    • isEmpty

      public boolean isEmpty()

    • 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. All components in this record class 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.

    • slot

      public int slot()
      Returns the value of the slot record component.
      Returns:
      the value of the slot record component

    • itemId

      public int itemId()
      Returns the value of the itemId record component.
      Returns:
      the value of the itemId record component

    • quantity

      public int quantity()
      Returns the value of the quantity record component.
      Returns:
      the value of the quantity record component