Package software.coley.treemap.squaring

Record Class Rectangle<T>

java.lang.Object
java.lang.Record
software.coley.treemap.squaring.Rectangle<T>
Type Parameters:
T - Associated data type.
Record Components:
data - Associated data.
While null may be passed for temporary usage by Squarify, it is never null in practice.
x - X coordinate.
y - Y coordinate.
width - Width.
height - Height.
public record Rectangle<T>(T data, double x, double y, double width, double height) extends Record
Basic rectangle with associated data.
Author:
Matt coley

  • Constructor Summary

    Constructors
    Constructor
    Description
    Rectangle(T data, double x, double y, double width, double height)
    Creates an instance of a Rectangle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    data()
    Returns the value of the data 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.
    double
    height()
    Returns the value of the height record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    width()
    Returns the value of the width record component.
    double
    x()
    Returns the value of the x record component.
    double
    y()
    Returns the value of the y record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Rectangle

      public Rectangle(T data, double x, double y, double width, double height)
      Creates an instance of a Rectangle record class.
      Parameters:
      data - the value for the data record component
      x - the value for the x record component
      y - the value for the y record component
      width - the value for the width record component
      height - the value for the height 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.

    • data

      public T data()
      Returns the value of the data record component.
      Returns:
      the value of the data record component

    • x

      public double x()
      Returns the value of the x record component.
      Returns:
      the value of the x record component

    • y

      public double y()
      Returns the value of the y record component.
      Returns:
      the value of the y record component

    • width

      public double width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component

    • height

      public double height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component