Package eu.cloudnetservice.common.tuple

Record Class Tuple2<F,S>

java.lang.Object

java.lang.Record

eu.cloudnetservice.common.tuple.Tuple2<F,S>

Type Parameters:

F - the first element type.

S - the second element type.

Record Components:

first - the first value of the tuple.

second - the second value of the tuple.

public record Tuple2<F,S>(@UnknownNullability F first, @UnknownNullability S second)
extends Record

A pair consisting of two elements: the first and second one. Both of these elements are allowed to be null. While the tuple implementation itself is immutable, there is no restriction if a type stored in a pair is immutable or not. If mutable values are stored in a pair the pair itself effectively becomes mutable.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final @UnknownNullability F	first	The field for the first record component.
private final @UnknownNullability S	second	The field for the second record component.

Constructor Summary

Constructors

Constructor	Description
Tuple2(@UnknownNullability F first, @UnknownNullability S second)	Creates an instance of a Tuple2 record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@UnknownNullability F	first()	Returns the value of the first record component.
final int	hashCode()	Returns a hash code value for this object.
@UnknownNullability S	second()	Returns the value of the second 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

Field Details

first

private final @UnknownNullability F first

The field for the first record component.

second

private final @UnknownNullability S second

The field for the second record component.

Constructor Details

Tuple2

public Tuple2(@UnknownNullability F first,
 @UnknownNullability S second)

Creates an instance of a Tuple2 record class.

Parameters:

first - the value for the first record component

second - the value for the second record component

Method Details

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.

first

public @UnknownNullability F first()

Returns the value of the first record component.

Returns:

the value of the first record component

second

public @UnknownNullability S second()

Returns the value of the second record component.

Returns:

the value of the second record component