Package net.tangly.commons.lang.functional

Record Class Pair<T,U>

java.lang.Object

java.lang.Record

net.tangly.commons.lang.functional.Pair<T,U>

Type Parameters:

T - left type of the pair

U - right type of the pair

public record Pair<T,U>(T left, U right)
extends Record

Defines a typed pair as long as JDK API is not providing the abstraction. Pairs can, for example, be used to return two values from a function. The regular approach is Java is to define an additional record type.

Constructor Summary

Constructors

Constructor	Description
Pair(T left, U right)	Creates an instance of a Pair 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.
T	left()	Returns the value of the left record component.
static <T, U> Pair<T,U>	of(T left, U right)
U	right()	Returns the value of the right record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Pair

public Pair(T left,
 U right)

Creates an instance of a Pair record class.

Parameters:

left - the value for the left record component

right - the value for the right record component

Method Details

of

public static <T,
U> Pair<T,U> of(T left,
 U right)

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 Objects::equals(Object,Object).

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.

left

public T left()

Returns the value of the left record component.

Returns:

the value of the left record component

right

public U right()

Returns the value of the right record component.

Returns:

the value of the right record component