Package studio.mevera.lotus.paper.internal.pagination

Record Class PaperPageMenu<T>

java.lang.Object
java.lang.Record
studio.mevera.lotus.paper.internal.pagination.PaperPageMenu<T>
All Implemented Interfaces:
studio.mevera.lotus.api.menu.InteractiveMenu<net.kyori.adventure.text.Component>, studio.mevera.lotus.api.menu.Menu<net.kyori.adventure.text.Component>, studio.mevera.lotus.api.menu.MenuHandler<net.kyori.adventure.text.Component>, PaperInteractiveMenu
public record PaperPageMenu<T>(@NotNull PaperPaginationSession<T> session, int pageIndex) extends Record implements PaperInteractiveMenu
Synthesised page menu backed by a PaperPageLayout. Returns Adventure Component titles with no serialization round-trip.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PaperPageMenu(@NotNull PaperPaginationSession<T> session, int pageIndex)
    Creates an instance of a PaperPageMenu record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull studio.mevera.lotus.api.slot.Capacity
    capacity(@NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
     
    @NotNull studio.mevera.lotus.api.content.Content
    content(@NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
     
    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()
     
    int
    pageIndex()
    Returns the value of the pageIndex record component.
    @NotNull PaperPaginationSession<T>
    session()
    Returns the value of the session record component.
    @NotNull net.kyori.adventure.text.Component
    title(@NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
     
    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

    Methods inherited from interface studio.mevera.lotus.api.menu.Menu

    type

    Methods inherited from interface studio.mevera.lotus.api.menu.MenuHandler

    onClose, onDrag, onOpen, onPostClick, onPreClick

  • Constructor Details

    • PaperPageMenu

      public PaperPageMenu(@NotNull @NotNull PaperPaginationSession<T> session, int pageIndex)
      Creates an instance of a PaperPageMenu record class.
      Parameters:
      session - the value for the session record component
      pageIndex - the value for the pageIndex record component

  • Method Details

    • title

      @NotNull public @NotNull net.kyori.adventure.text.Component title(@NotNull @NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
      Specified by:
      title in interface studio.mevera.lotus.api.menu.Menu<T>

    • capacity

      @NotNull public @NotNull studio.mevera.lotus.api.slot.Capacity capacity(@NotNull @NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
      Specified by:
      capacity in interface studio.mevera.lotus.api.menu.Menu<T>

    • content

      @NotNull public @NotNull studio.mevera.lotus.api.content.Content content(@NotNull @NotNull studio.mevera.lotus.api.menu.MenuView<net.kyori.adventure.text.Component,?> view)
      Specified by:
      content in interface studio.mevera.lotus.api.menu.Menu<T>

    • name

      @NotNull public @NotNull String name()
      Specified by:
      name in interface studio.mevera.lotus.api.menu.Menu<T>

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • session

      @NotNull public @NotNull PaperPaginationSession<T> session()
      Returns the value of the session record component.
      Returns:
      the value of the session record component

    • pageIndex

      public int pageIndex()
      Returns the value of the pageIndex record component.
      Returns:
      the value of the pageIndex record component