Record Class FoliosBook.CategoryView

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.FoliosBook.CategoryView
Enclosing class:
FoliosBook
public static record FoliosBook.CategoryView(boolean grid, boolean scroll) extends Record
How the front of the book lists its categories: "categories" in book.json. 
"categories": {
  "view": "grid",       // "list" (default): a row each; "grid": a tile each, its icon over its name
  "overflow": "scroll"  // "pages" (default): more pages when they don't fit; "scroll": one page that scrolls
}

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final FoliosBook.CategoryView
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CategoryView(boolean grid, boolean scroll)
    Creates an instance of a CategoryView record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    grid()
    Returns the value of the grid record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    scroll()
    Returns the value of the scroll 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

  • Field Details

  • Constructor Details

    • CategoryView

      public CategoryView(boolean grid, boolean scroll)
      Creates an instance of a CategoryView record class.
      Parameters:
      grid - the value for the grid record component
      scroll - the value for the scroll 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 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.

    • grid

      public boolean grid()
      Returns the value of the grid record component.
      Returns:
      the value of the grid record component

    • scroll

      public boolean scroll()
      Returns the value of the scroll record component.
      Returns:
      the value of the scroll record component