Package net.okocraft.box.feature.craft.event.stock

Record Class CraftCause

java.lang.Object
java.lang.Record
net.okocraft.box.feature.craft.event.stock.CraftCause
Record Components:
crafter - the Player who craft items
selectedRecipe - the SelectedRecipe used to craft items
All Implemented Interfaces:
StockEvent.Cause
public record CraftCause(@NotNull Player crafter, @NotNull SelectedRecipe selectedRecipe) extends Record implements StockEvent.Cause
A StockEvent.Cause implementation indicating that the amount of stock has been modified by crafting.

  • Constructor Details

    • CraftCause

      public CraftCause(@NotNull @NotNull Player crafter, @NotNull @NotNull SelectedRecipe selectedRecipe)
      Creates an instance of a CraftCause record class.
      Parameters:
      crafter - the value for the crafter record component
      selectedRecipe - the value for the selectedRecipe record component

  • Method Details

    • name

      @NotNull public @NotNull String name()
      Description copied from interface: StockEvent.Cause
      Gets the string that indicates the cause.

      This method returns a string that is a concise representation of the "cause".

      For example, an API call is "api", and a player's stock deposit/withdrawal is "deposit" or "withdraw".

      Specified by:
      name in interface StockEvent.Cause
      Returns:
      the string that indicates the cause

    • 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 Objects::equals(Object,Object).
      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.

    • crafter

      @NotNull public @NotNull Player crafter()
      Returns the value of the crafter record component.
      Returns:
      the value of the crafter record component

    • selectedRecipe

      @NotNull public @NotNull SelectedRecipe selectedRecipe()
      Returns the value of the selectedRecipe record component.
      Returns:
      the value of the selectedRecipe record component