Record Class GuideReader.Spot

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.GuideReader.Spot
Enclosing class:
GuideReader
public static record GuideReader.Spot(String chapter, int page) extends Record
A place in the book: a part of it ("home", "category:", "entry:", "search:", "bookmarks", "index") and the left page of a spread.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Spot(String chapter, int page)
    Creates an instance of a Spot record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    chapter()
    Returns the value of the chapter 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 Object

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

  • Constructor Details

    • Spot

      public Spot(String chapter, int page)
      Creates an instance of a Spot record class.
      Parameters:
      chapter - the value for the chapter record component
      page - the value for the page 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 the compare method from their corresponding wrapper classes.
      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.

    • chapter

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

    • page

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