Pair

class Pair<A, B>(val first: A, val second: B) : PairComponents(source)

Stores two typed values with component-wise equality and positional destructuring.

The component references cannot be replaced, but objects stored in them may still be mutable. Construction and copy retain those values without making deep copies. Both component types may be nullable. Guest Pair type parameters are invariant.

val entry = "name" to 42
val (name, value) = entry

Parameters

first

first component value.

second

second component value.

Type Parameters

type of the first component.

type of the second component.

Constructors

Pair

constructor(first: A, second: B)

Creates a pair containing the supplied values.

Properties

first

val first: A

First component, retaining its declared type and value.

firstComponent

open override val firstComponent: Any?

First component exposed as a nullable Any value.

second

val second: B

Second component, retaining its declared type and value.

secondComponent

open override val secondComponent: Any?

Second component exposed as a nullable Any value.

Functions

component1

operator fun component1(): A

Returns the first component for positional destructuring.

component2

operator fun component2(): B

Returns the second component for positional destructuring.

copy

fun copy(first: A, second: B): Pair<A, B>

Creates a new pair using both explicitly supplied component values.

equals

open operator override fun equals(other: Any?): Boolean

Compares this pair with another PairComponents value component by component.

hashCode

open override fun hashCode(): Int

Combines the hash codes of both component values.

toString

open override fun toString(): String

Formats the components as (first, second) using their text conversions.

Pair

Parameters

Type Parameters

See also

Constructors

Properties

Functions