Package net.okocraft.box.feature.gui.api.buttons

Record Class CloseButton

java.lang.Object
java.lang.Record
net.okocraft.box.feature.gui.api.buttons.CloseButton
All Implemented Interfaces:
Button
public record CloseButton(int slot) extends Record implements Button

  • Constructor Summary

    Constructors
    Constructor
    Description
    CloseButton(int slot)
    Creates an instance of a CloseButton record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.bukkit.inventory.ItemStack
    createIcon(@NotNull PlayerSession session)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    getSlot()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull ClickResult
    onClick(@NotNull PlayerSession session, @NotNull org.bukkit.event.inventory.ClickType clickType)
     
    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 java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • CloseButton

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

  • Method Details

    • getSlot

      public int getSlot()
      Specified by:
      getSlot in interface Button

    • createIcon

      @NotNull public @NotNull org.bukkit.inventory.ItemStack createIcon(@NotNull @NotNull PlayerSession session)
      Specified by:
      createIcon in interface Button

    • onClick

      @NotNull public @NotNull ClickResult onClick(@NotNull @NotNull PlayerSession session, @NotNull @NotNull org.bukkit.event.inventory.ClickType clickType)
      Specified by:
      onClick in interface Button

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