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

Record Class StickCauses.ItemConsume

java.lang.Object
java.lang.Record
net.okocraft.box.feature.stick.event.stock.StickCauses.ItemConsume
Record Components:
player - the player that used the Box Stick
All Implemented Interfaces:
StockEvent.Cause, StickCause
Enclosing class:
StickCauses
public static record StickCauses.ItemConsume(@NotNull BoxPlayer player) extends Record implements StickCause
A record of StickCause indicating that a Box Stick was used when the player consumed the items.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ItemConsume(@NotNull BoxPlayer player)
    Creates an instance of a ItemConsume 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.
    @NotNull String
    name()
    Gets the string that indicates the cause.
    @NotNull BoxPlayer
    player()
    Returns the value of the player record component.
    final 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

  • Constructor Details

    • ItemConsume

      public ItemConsume(@NotNull @NotNull BoxPlayer player)
      Creates an instance of a ItemConsume record class.
      Parameters:
      player - the value for the player 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.

    • player

      @NotNull public @NotNull BoxPlayer player()
      Returns the value of the player record component.
      Specified by:
      player in interface StickCause
      Returns:
      the value of the player record component