Record Class GuideEntry.Page

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.GuideEntry.Page
Record Components:
anchor - a name links can reach it by; null for none
icon - shown before its title: its own ("icon"; GuideIcon.NONE for "none"), or null for the entry's on its first page and none on the others
Enclosing class:
GuideEntry
public static record GuideEntry.Page(GuidePage page, @Nullable String anchor, GuideLock lock, @Nullable GuideIcon icon) extends Record
A page of the entry, with what applies to it whatever its kind.

  • Constructor Details

    • Page

      public Page(GuidePage page, @Nullable String anchor, GuideLock lock)

    • Page

      public Page(GuidePage page, @Nullable String anchor, GuideLock lock, @Nullable GuideIcon icon)
      Creates an instance of a Page record class.
      Parameters:
      page - the value for the page record component
      anchor - the value for the anchor record component
      lock - the value for the lock record component
      icon - the value for the icon record component

  • Method Details

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

    • page

      public GuidePage page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component

    • anchor

      public @Nullable String anchor()
      Returns the value of the anchor record component.
      Returns:
      the value of the anchor record component

    • lock

      public GuideLock lock()
      Returns the value of the lock record component.
      Returns:
      the value of the lock record component

    • icon

      public @Nullable GuideIcon icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component