Package studio.mevera.lotus.api.button

Record Class TransformingButton

java.lang.Object
java.lang.Record
studio.mevera.lotus.api.button.TransformingButton
All Implemented Interfaces:
Button
public record TransformingButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull BiFunction<MenuView<?,?>,org.bukkit.event.inventory.InventoryClickEvent,Button> transformer, @NotNull DataRegistry data) extends Record implements Button

  • Constructor Summary

    Constructors
    Constructor
    Description
    TransformingButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull BiFunction<MenuView<?,?>,org.bukkit.event.inventory.InventoryClickEvent,Button> transformer, @NotNull DataRegistry data)
    Creates an instance of a TransformingButton record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull DataRegistry
    data()
    Returns the value of the data record component.
    void
    dispatch(@NotNull MenuView<?,?> view, @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
     
    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 org.bukkit.inventory.ItemStack
    item()
    Returns the value of the item record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull BiFunction<MenuView<?,?>,org.bukkit.event.inventory.InventoryClickEvent,Button>
    transformer()
    Returns the value of the transformer record component.
    @NotNull TransformingButton
    withItem(@NotNull org.bukkit.inventory.ItemStack item)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TransformingButton

      public TransformingButton(@NotNull @NotNull org.bukkit.inventory.ItemStack item, @NotNull @NotNull BiFunction<MenuView<?,?>,org.bukkit.event.inventory.InventoryClickEvent,Button> transformer, @NotNull @NotNull DataRegistry data)
      Creates an instance of a TransformingButton record class.
      Parameters:
      item - the value for the item record component
      transformer - the value for the transformer record component
      data - the value for the data record component

  • Method Details

    • withItem

      @NotNull public @NotNull TransformingButton withItem(@NotNull @NotNull org.bukkit.inventory.ItemStack item)
      Specified by:
      withItem in interface Button

    • dispatch

      public void dispatch(@NotNull @NotNull MenuView<?,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Specified by:
      dispatch 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 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.

    • item

      @NotNull public @NotNull org.bukkit.inventory.ItemStack item()
      Returns the value of the item record component.
      Specified by:
      item in interface Button
      Returns:
      the value of the item record component

    • transformer

      @NotNull public @NotNull BiFunction<MenuView<?,?>,org.bukkit.event.inventory.InventoryClickEvent,Button> transformer()
      Returns the value of the transformer record component.
      Returns:
      the value of the transformer record component

    • data

      @NotNull public @NotNull DataRegistry data()
      Returns the value of the data record component.
      Specified by:
      data in interface Button
      Returns:
      the value of the data record component