Record Class FoliosLayout.Mark

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.page.FoliosLayout.Mark
Enclosing class:
FoliosLayout
public static record FoliosLayout.Mark(int page, int top, int bottom) extends Record
A named place on the pages a page lays out: the pageth of them (from 0), from top down to bottom on it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Mark(int page, int top, int bottom)
    Creates an instance of a Mark record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bottom()
    Returns the value of the bottom 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.
    int
    top()
    Returns the value of the top 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

    • Mark

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

    • page

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

    • top

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

    • bottom

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