Record Class GuideListEntry

java.lang.Object
java.lang.Record
ke.ric.api.guide.GuideListEntry
public record GuideListEntry(org.bukkit.inventory.ItemStack item, GuideAction leftClick, GuideAction rightClick) extends Record
An item in a Core-paginated guide list.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GuideListEntry(org.bukkit.inventory.ItemStack item)
     
    GuideListEntry(org.bukkit.inventory.ItemStack item, GuideAction leftClick, GuideAction rightClick)
    Creates an instance of a GuideListEntry 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.
    org.bukkit.inventory.ItemStack
    item()
    Returns the value of the item record component.
    GuideAction
    leftClick()
    Returns the value of the leftClick record component.
    GuideAction
    rightClick()
    Returns the value of the rightClick record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • GuideListEntry

      public GuideListEntry(org.bukkit.inventory.ItemStack item)

    • GuideListEntry

      public GuideListEntry(org.bukkit.inventory.ItemStack item, GuideAction leftClick, GuideAction rightClick)
      Creates an instance of a GuideListEntry record class.
      Parameters:
      item - the value for the item record component
      leftClick - the value for the leftClick record component
      rightClick - the value for the rightClick record component

  • Method Details

    • item

      public org.bukkit.inventory.ItemStack item()
      Returns the value of the item record component.
      Returns:
      the value of the item record component

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

    • leftClick

      public GuideAction leftClick()
      Returns the value of the leftClick record component.
      Returns:
      the value of the leftClick record component

    • rightClick

      public GuideAction rightClick()
      Returns the value of the rightClick record component.
      Returns:
      the value of the rightClick record component