Package limn.print

Record Class PageInfo

java.lang.Object
java.lang.Record
limn.print.PageInfo
Record Components:
number - the page's number, from 1
count - how many pages the document has
paper - the paper the document is laid out on
public record PageInfo(int number, int count, Paper paper) extends Record
Which page a header or a footer is drawn for: its number, how many pages the document has, and the paper. Known only once the document has been cut into pages, which is why a header and a footer are functions of it (Document.header, Document.footer).

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageInfo(int number, int count, Paper paper)
    Creates an instance of a PageInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    count()
    Returns the value of the count 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.
    boolean
    isFirst()
     
    boolean
    isLast()
     
    int
    number()
    Returns the value of the number record component.
    Paper
    paper()
    Returns the value of the paper 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

    • PageInfo

      public PageInfo(int number, int count, Paper paper)
      Creates an instance of a PageInfo record class.
      Parameters:
      number - the value for the number record component
      count - the value for the count record component
      paper - the value for the paper record component

  • Method Details

    • isFirst

      public boolean isFirst()
      Returns:
      whether this is the first page

    • isLast

      public boolean isLast()
      Returns:
      whether this is the last page

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

    • number

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

    • count

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

    • paper

      public Paper paper()
      Returns the value of the paper record component.
      Returns:
      the value of the paper record component