Record Class TableRowGroup

java.lang.Object
java.lang.Record
com.nsdev.lettergenerator.model.table.TableRowGroup
Record Components:
startRow - first zero-based body row index
rowCount - positive number of rows in the group
keepTogether - required keep strength, including AUTO to allow normal breaks

public record TableRowGroup(int startRow, int rowCount, Keep keepTogether) extends Record
Consecutive body rows requested to stay on one page. Groups cannot overlap and cannot include header rows. A soft preference may break when necessary; an impossible strong keep can fail.
  • Constructor Summary

    Constructors
    Constructor
    Description
    TableRowGroup(int startRow, int rowCount, Keep keepTogether)
    Creates an instance of a TableRowGroup record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the keepTogether record component.
    int
    Returns the value of the rowCount record component.
    int
    Returns the value of the startRow record component.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • TableRowGroup

      public TableRowGroup(int startRow, int rowCount, Keep keepTogether)
      Creates an instance of a TableRowGroup record class.
      Parameters:
      startRow - the value for the startRow record component
      rowCount - the value for the rowCount record component
      keepTogether - the value for the keepTogether 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.
    • startRow

      public int startRow()
      Returns the value of the startRow record component.
      Returns:
      the value of the startRow record component
    • rowCount

      public int rowCount()
      Returns the value of the rowCount record component.
      Returns:
      the value of the rowCount record component
    • keepTogether

      public Keep keepTogether()
      Returns the value of the keepTogether record component.
      Returns:
      the value of the keepTogether record component