Package com.storedobject.svg

Record Class Coordinates

java.lang.Object

java.lang.Record

com.storedobject.svg.Coordinates

Record Components:

x1 - The x-coordinate of the top-left corner.

y1 - The y-coordinate of the top-left corner.

x2 - The x-coordinate of the bottom-right corner.

y2 - The y-coordinate of the bottom-right corner.

public record Coordinates(double x1, double y1, double x2, double y2)
extends Record

Represents a coordinate system defined by two points (x1, y1) and (x2, y2). The boundary is adjusted to ensure the coordinates reflect a valid rectangular region, where (x1, y1) represent the top-left corner, and (x2, y2) represent the bottom-right corner.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
Coordinates()	Default constructor that initializes the Coordinates object with zero values for all points.
Coordinates(double x1, double y1, double x2, double y2)	Constructs a Coordinates object by defining a rectangular region based on two points (x1, y1) and (x2, y2).
Coordinates(Node node)	Constructs a Coordinates object by initializing the rectangular region using the coordinates of the given Node object.
Coordinates(Point p)	Constructs a Coordinates object by defining a rectangular region where both the top-left and bottom-right corners are represented by the same Point.
Coordinates(Point p1, Point p2)	Constructs a Coordinates object by defining a rectangular region based on two Point objects.

Method Summary

Modifier and Type	Method	Description
Coordinates	combine(Coordinates c)	Combines the current Coordinates object with the specified Coordinates object to create a new rectangular region.
Coordinates	combine(Node node)	Combines the current Coordinates object with the rectangular region represented by the given Node object.
Coordinates	combine(Point p)	Combines the current Coordinates object with a rectangular region derived from the specified Point object.
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()	Calculates the height of the rectangular region based on the difference between the y-coordinates of the bottom-right and top-left corners.
void	setTo(Node node)	Sets the coordinates of the given Node object to match the current Coordinates object.
final String	toString()	Returns a string representation of this record class.
double	width()	Calculates the width of the rectangular region based on the difference between the x-coordinates of the bottom-right and top-left corners.
double	x1()	Returns the value of the x1 record component.
double	x2()	Returns the value of the x2 record component.
double	y1()	Returns the value of the y1 record component.
double	y2()	Returns the value of the y2 record component.

Methods inherited from class java.lang.Object

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

Constructor Details

Coordinates

public Coordinates()

Default constructor that initializes the Coordinates object with zero values for all points. This results in a rectangle represented by the top-left corner (0, 0) and bottom-right corner (0, 0).

Coordinates

public Coordinates(double x1,
 double y1,
 double x2,
 double y2)

Constructs a Coordinates object by defining a rectangular region based on two points (x1, y1) and (x2, y2). The coordinates are adjusted so that (x1, y1) represents the top-left corner and (x2, y2) represents the bottom-right corner of the rectangle.

Parameters:

x1 - The x-coordinate of the first point.

y1 - The y-coordinate of the first point.

x2 - The x-coordinate of the second point.

y2 - The y-coordinate of the second point.

Coordinates

public Coordinates(Point p1,
 Point p2)

Constructs a Coordinates object by defining a rectangular region based on two Point objects. The coordinates are adjusted so that the rectangle is represented with the top-left corner as (x1, y1) and the bottom-right corner as (x2, y2).

Parameters:

p1 - The first point defining the rectangular region.

p2 - The second point defining the rectangular region.

Coordinates

public Coordinates(Point p)

Constructs a Coordinates object by defining a rectangular region where both the top-left and bottom-right corners are represented by the same Point. This effectively creates a rectangle with zero width and height at the given point.

Parameters:

p - The point defining both the top-left and bottom-right corners of the rectangular region.

Coordinates

public Coordinates(Node node)

Constructs a Coordinates object by initializing the rectangular region using the coordinates of the given Node object. The coordinates from the node are used to represent the top-left corner (x1, y1) and the bottom-right corner (x2, y2) of the rectangle.

Parameters:

node - The Node object providing the coordinates to initialize the rectangular region.

Method Details

width

public double width()

Calculates the width of the rectangular region based on the difference between the x-coordinates of the bottom-right and top-left corners.

Returns:

The width of the rectangular region.

height

public double height()

Calculates the height of the rectangular region based on the difference between the y-coordinates of the bottom-right and top-left corners.

Returns:

The height of the rectangular region.

combine

public Coordinates combine(Coordinates c)

Combines the current Coordinates object with the specified Coordinates object to create a new rectangular region. The resulting region is the smallest rectangle that can fully contain both the current and the specified Coordinates.

Parameters:

c - The Coordinates object to combine with the current object.

Returns:

A new Coordinates object representing the combined rectangular region.

combine

public Coordinates combine(Node node)

Combines the current Coordinates object with the rectangular region represented by the given Node object. The resulting Coordinates represents the smallest rectangle that can fully contain both the current region and the region derived from the specified Node.

Parameters:

node - The Node object containing the coordinates to be combined.

Returns:

A new Coordinates object representing the combined rectangular region.

combine

public Coordinates combine(Point p)

Combines the current Coordinates object with a rectangular region derived from the specified Point object. The resulting region is the smallest rectangle that can fully contain both the current Coordinates and the region represented by the specified Point.

Parameters:

p - The Point object whose coordinates are used to define the rectangular region to combine with.

Returns:

A new Coordinates object representing the combined rectangular region.

setTo

public void setTo(Node node)

Sets the coordinates of the given Node object to match the current Coordinates object. The fields x1, y1, x2, and y2 of the provided Node are updated using the corresponding values from this Coordinates object.

Parameters:

node - The Node object whose coordinates will be updated.

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.

x1

public double x1()

Returns the value of the x1 record component.

Returns:

the value of the x1 record component

y1

public double y1()

Returns the value of the y1 record component.

Returns:

the value of the y1 record component

x2

public double x2()

Returns the value of the x2 record component.

Returns:

the value of the x2 record component

y2

public double y2()

Returns the value of the y2 record component.

Returns:

the value of the y2 record component