de.frame4j.math

Class IntPair

java.lang.Object

de.frame4j.math.IntPair

All Implemented Interfaces:

ConstIntPair, Serializable

public final class IntPair
extends Object
implements ConstIntPair, Serializable

A pair of integer numbers.

Objects of this class hold a pair (x, y) of int values.
Contrary to IntPairFix, IntPairs are mutable.
Hence, when IntPairFixs were used to substitute Point, Dimension, Rectangle and others due to their design flaws, IntPairs can substitute them under a common type in the rare cases, where their mutability is really used, e.g. for changeable common locations of multiple objects.
In those cases best use Albrecht Weinert's const interface patters by giving the dependent objects a watertight r/o view.


© Copyright 2016 Albrecht Weinert

Version:

39 (17.04.2021)

Author:

Albrecht Weinert

See Also:

de.frame4j.math, Complex, CFun, Serialized Form

Method Summary

Modifier and Type	Method and Description
ConstIntPair	constView() Provide a r/o view to the IntPair object.
boolean	equals(Object o) Compare with other Object.
int	getX() The first value (x, width, real and else).
int	getY() The second value (y, height, imaginary and else).
int	hashCode() Get the hashCode.
static IntPair	of(Dimension dim) Make of Dimension.
static IntPair	of(Point point) Make of Point.
static IntPair	ofInts(int x, int y) Make of two integer values.
void	setX(int x) Set the first value (x, width, real and else).
void	setY(int y) The second value (y, height, imaginary and else).
String	toString() As String (x, y).

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.frame4j.math.ConstIntPair

asDim, asIntPairFix, asPoint, asString, calcHash, equals

Method Detail

getX

public final int getX()

The first value (x, width, real and else).

Specified by:

getX in interface ConstIntPair

getY

public final int getY()

The second value (y, height, imaginary and else).

Specified by:

getY in interface ConstIntPair

setX

public final void setX(int x)

Set the first value (x, width, real and else).

setY

public final void setY(int y)

The second value (y, height, imaginary and else).

ofInts

public static final IntPair ofInts(int x,
                                   int y)

Make of two integer values.

of

public static final IntPair of(Dimension dim)

Make of Dimension.

Parameters:

dim - for width, height; null gets (0, 0)

of

public static final IntPair of(Point point)

Make of Point.

Parameters:

point - for x, y; null gets (0, 0)

equals

public boolean equals(Object o)

Compare with other Object.

Overrides:

equals in class Object

See Also:

ConstIntPair.equals(ConstIntPair)

hashCode

public int hashCode()

Get the hashCode.

Overrides:

hashCode in class Object

toString

public String toString()

As String (x, y).

Overrides:

toString in class Object

See Also:

ConstIntPair.asString()

constView

public ConstIntPair constView()

Provide a r/o view to the IntPair object.

This method provides a ConstIntPair object giving a complete view to the state of this IntPair. All changes will be seen, but the ConstIntPair object will under no circumstances allow the holder to change this IntPair's state.

Hint this is (sematically) different from ConstIntPair.asIntPairFix().