Record Class TransactionResult

java.lang.Object
java.lang.Record
net.okocraft.box.api.transaction.TransactionResult
Record Components:
item - the transacted item
amount - the amount of the transacted item
public record TransactionResult(@NotNull BoxItem item, int amount) extends Record
A record class to indicate transaction result.

  • Constructor Details

    • TransactionResult

      public TransactionResult(@NotNull @NotNull BoxItem item, int amount)
      A constructor of TransactionResult.
      Parameters:
      item - the transacted item
      amount - the amount of the transacted item
      Throws:
      IllegalArgumentException - if amount is negative

  • Method Details

    • create

      @Contract(value="_, _ -> new", pure=true) @NotNull public static @NotNull TransactionResult create(@NotNull @NotNull BoxItem item, int amount)
      Creates a new TransactionResult.
      Parameters:
      item - the transacted item
      amount - the amount of the transacted item
      Returns:
      a new TransactionResult
      Throws:
      IllegalArgumentException - if amount is negative

    • getItem

      @Obsolete @NotNull public @NotNull BoxItem getItem()
      Gets the transacted item.
      Returns:
      the transacted item

    • getAmount

      @Obsolete public int getAmount()
      Gets the amount of the transacted item.
      Returns:
      the amount of the transacted item

    • 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.

    • item

      @NotNull public @NotNull BoxItem item()
      Returns the value of the item record component.
      Returns:
      the value of the item record component

    • amount

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