Package studio.mevera.lotus.api.button

Record Class CompositeButton

java.lang.Object
java.lang.Record
studio.mevera.lotus.api.button.CompositeButton
All Implemented Interfaces:
Button
public record CompositeButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull List<Button> children, @NotNull DataRegistry data) extends Record implements Button
A button that aggregates several child buttons under a single display item, dispatching each child in declaration order on click. Implements the Composite pattern over the Button algebra: the composite IS-A Button and HAS-A list of Buttons.

Use this when one click should perform several independent effects without forcing the caller to manually compose ClickActions — for example "play a sound + send a message + run a command" can be three small ClickableButtons combined into one composite.

The composite owns its own item(); child items are ignored for rendering. This keeps "what the user sees" decoupled from "what happens on click", which is the whole point of the pattern in this context.

Caveats: children that mutate the view (notably TransformingButton, which replaces the slot's button on click) compose unpredictably — the first such child wins and subsequent children dispatch against a button that is no longer in the view. Prefer StaticButton and ClickableButton children for predictable composition.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CompositeButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull List<Button> children, @NotNull DataRegistry data)
    Creates an instance of a CompositeButton record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull List<Button>
    children()
    Returns the value of the children record component.
    @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 CompositeButton
    withItem(@NotNull org.bukkit.inventory.ItemStack item)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CompositeButton

      public CompositeButton(@NotNull @NotNull org.bukkit.inventory.ItemStack item, @NotNull @NotNull List<Button> children, @NotNull @NotNull DataRegistry data)
      Creates an instance of a CompositeButton record class.
      Parameters:
      item - the value for the item record component
      children - the value for the children record component
      data - the value for the data record component

  • Method Details

    • withItem

      @NotNull public @NotNull CompositeButton 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

    • children

      @NotNull public @NotNull List<Button> children()
      Returns the value of the children record component.
      Returns:
      the value of the children 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