Package org.openpdf.layout

Record Class FloatManager.BoxDistance

java.lang.Object
java.lang.Record
org.openpdf.layout.FloatManager.BoxDistance
Enclosing class:
FloatManager
private static record FloatManager.BoxDistance(@Nullable BlockBox box, int distance) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final @Nullable BlockBox
    box
    The field for the box record component.
    private final int
    distance
    The field for the distance record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    BoxDistance(@Nullable BlockBox box, int distance)
    Creates an instance of a BoxDistance record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable BlockBox
    box()
    Returns the value of the box record component.
    int
    distance()
    Returns the value of the distance 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.
    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

  • Field Details

    • box

      private final @Nullable BlockBox box
      The field for the box record component.

    • distance

      private final int distance
      The field for the distance record component.

  • Constructor Details

    • BoxDistance

      private BoxDistance(@Nullable BlockBox box, int distance)
      Creates an instance of a BoxDistance record class.
      Parameters:
      box - the value for the box record component
      distance - the value for the distance 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.

    • box

      public @Nullable BlockBox box()
      Returns the value of the box record component.
      Returns:
      the value of the box record component

    • distance

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