Package codechicken.lib.gui.modular.lib.geometry

Record Class Rectangle.Immutable

java.lang.Object

java.lang.Record

codechicken.lib.gui.modular.lib.geometry.Rectangle.Immutable

All Implemented Interfaces:

Rectangle

Enclosing interface:

Rectangle

public static record Rectangle.Immutable(Position position, double xSize, double ySize)
extends Record
implements Rectangle

Should not be created directly

Nested Class Summary

Nested classes/interfaces inherited from interface codechicken.lib.gui.modular.lib.geometry.Rectangle

Rectangle.Dynamic, Rectangle.Immutable, Rectangle.Mutable

Constructor Summary

Constructors

Constructor	Description
Immutable(Position position, double xSize, double ySize)	Creates an instance of a Immutable 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.
double	height()
Position	pos()
Position	position()	Returns the value of the position record component.
String	toString()	Returns a string representation of this record class.
double	width()
double	xSize()	Returns the value of the xSize record component.
double	ySize()	Returns the value of the ySize record component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface codechicken.lib.gui.modular.lib.geometry.Rectangle

combine, contains, distance, intersect, intersects, intersects, max, min, mutable, offsetPos, offsetSize, setPos, setSize, size, toRect2i, x, xMax, y, yMax

Constructor Details

Immutable

public Immutable(Position position,
 double xSize,
 double ySize)

Creates an instance of a Immutable record class.

Parameters:

position - the value for the position record component

xSize - the value for the xSize record component

ySize - the value for the ySize record component

Method Details

pos

public Position pos()

Specified by:

pos in interface Rectangle

width

public double width()

Specified by:

width in interface Rectangle

height

public double height()

Specified by:

height in interface Rectangle

toString

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

position

public Position position()

Returns the value of the position record component.

Returns:

the value of the position record component

xSize

public double xSize()

Returns the value of the xSize record component.

Returns:

the value of the xSize record component

ySize

public double ySize()

Returns the value of the ySize record component.

Returns:

the value of the ySize record component