Top Description Fields Constructors Methods
io.github.darvil.utils

public final Record Pair<TFirst, TSecond>

extends Record
Class Inheritance
Record Components
first:TFirst 
second:TSecond 
Type Parameters
<TFirst>
The type of the first object.
<TSecond>
The type of the second object.
A record that stores two objects.

Field Summary

Modifier and TypeField and Description
private final TFirst
first

Record Component accessed by first().

private final TSecond
second

Record Component accessed by second().

Constructor Summary

AccessConstructor and Description
public
Pair(TFirst first, TSecond second)

Method Summary

Modifier and TypeMethod and Description
public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.

public TFirst
first()

Record Component getter of first.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public TSecond
second()

Record Component getter of second.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

firstback to summary
private final TFirst first

Record Component accessed by first().

secondback to summary
private final TSecond second

Record Component accessed by second().

Constructor Detail

Pairback to summary
public Pair(TFirst first, TSecond second)

Method Detail

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
firstback to summary
public TFirst first()

Record Component getter of first.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

secondback to summary
public TSecond second()

Record Component getter of second.

toStringback to summary
public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.