Package com.thanlinardos.spring_enterprise_library.tuple

Record Class Pair<S,T>

java.lang.Object

java.lang.Record

com.thanlinardos.spring_enterprise_library.tuple.Pair<S,T>

Type Parameters:

S - Type of the first thing.

T - Type of the second thing.

Record Components:

first - The first thing.

second - The second thing.

public record Pair<S,T>(S first, T second)
extends Record

A tuple of things.

Constructor Summary

Constructors

Constructor	Description
Pair(S first, T second)	Creates a new Pair for the given elements.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
S	first()	Returns the value of the first record component.
int	hashCode()	Returns a hash code value for this object.
static <S, T> Pair<S,T>	of(S first, T second)	Creates a new Pair for the given elements.
T	second()	Returns the value of the second record component.
static <S, T> Collector<Pair<S,T>,?,Map<S,T>>	toMap()	A collector to create a Map from a Stream of Pairs.
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(S first,
 T second)

Creates a new Pair for the given elements.

Parameters:

first - must not be null.

second - must not be null.

Method Details

of

public static <S,
T> Pair<S,T> of(S first,
 T second)

Creates a new Pair for the given elements.

Type Parameters:

S - Type of the first thing.

T - Type of the second thing.

Parameters:

first - must not be null.

second - must not be null.

Returns:

the Pair.

toMap

public static <S,
T>
Collector<Pair<S,T>,?,Map<S,T>> toMap()

A collector to create a Map from a Stream of Pairs.

Type Parameters:

S - Type of the first thing.

T - Type of the second thing.

Returns:

the Collector to create a Map.

equals

public boolean equals(@Nullable
 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.

hashCode

public 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

toString

@Nonnull
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

first

public S first()

Returns the value of the first record component.

Returns:

the value of the first record component

second

public T second()

Returns the value of the second record component.

Returns:

the value of the second record component