Module com.slinky.hackmaster
Package com.slinky.hackmaster.util

Record Class Dimension

java.lang.Object
java.lang.Record
com.slinky.hackmaster.util.Dimension
Record Components:
width - the width component of the dimension, or the number of columns
height - the height component of the dimension, or the number of rows
public record Dimension(int width, int height) extends Record
The Dimension record represents a two-dimensional measurement with width and height components. This record is primarily intended to model dimensions in graphical or UI contexts, such as screen sizes, window dimensions, or other rectangular spaces.

Additionally, the Dimension record can be conveniently used to represent other pairs of values, such as rows and columns in a grid, where width could correspond to the number of columns and height to the number of rows.

Example usage: 

 Dimension screenSize = new Dimension(1920, 1080);
 int width  = screenSize.width();
 int height = screenSize.height();

 Dimension gridSize = new Dimension(5, 10); // 5 columns and 10 rows
 int rows    = gridSize.height();
 int columns = gridSize.width();

Author:
Kheagen Haskins

  • Constructor Summary

    Constructors
    Constructor
    Description
    Dimension(int width, int height)
    Creates an instance of a Dimension record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Dimension

      public Dimension(int width, int height)
      Creates an instance of a Dimension record class.
      Parameters:
      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. All components in this record class 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.

    • width

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

    • height

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