Package net.ixdarklord.folios.api.client

Record Class FoliosBook.Location

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.FoliosBook.Location
Enclosing class:
FoliosBook
public static record FoliosBook.Location(String entry, int page, int element) extends Record
A place in a book: an entry, a page of it (0 for its first), and an element of that page (0 for its first; -1 for the page as a whole).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Location(String entry, int page)
    A page as a whole.
    Location(String entry, int page, int element)
    Creates an instance of a Location record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    element()
    Returns the value of the element record component.
    String
    entry()
    Returns the value of the entry record component.
    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.
    int
    page()
    Returns the value of the page record component.
    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

  • Constructor Details

    • Location

      public Location(String entry, int page)
      A page as a whole.

    • Location

      public Location(String entry, int page, int element)
      Creates an instance of a Location record class.
      Parameters:
      entry - the value for the entry record component
      page - the value for the page record component
      element - the value for the element 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. 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.

    • entry

      public String entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry record component

    • page

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

    • element

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