kotlin-stdlib/kotlin/Pair

Pair

data class Pair<out A, out B>(val first: A, val second: B) : Serializable(source)

Represents a generic pair of two values.

There is no meaning attached to values in this class, it can be used for any purpose. Pair exhibits value semantics, i.e. two pairs are equal if both components are equal.

An example of decomposing it into values:

Since Kotlin

1.1

Parameters

A

type of the first value.

B

type of the second value.

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   val (a, b) = Pair(1, "x")
println(a) // 1
println(b) // x 
   //sampleEnd
}
data class Pair<out A, out B>(val first: A, val second: B) : Serializable(source)

Represents a generic pair of two values.

There is no meaning attached to values in this class, it can be used for any purpose. Pair exhibits value semantics, i.e. two pairs are equal if both components are equal.

An example of decomposing it into values:

Since Kotlin

1.0

Parameters

A

type of the first value.

B

type of the second value.

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   val (a, b) = Pair(1, "x")
println(a) // 1
println(b) // x 
   //sampleEnd
}

Constructors

Link copied to clipboard
constructor(first: A, second: B)

Creates a new instance of Pair.

constructor(first: A, second: B)

Creates a new instance of Pair.

Properties

Link copied to clipboard
val first: A

First value.

Since Kotlin 1.1
val first: A

First value.

Since Kotlin 1.0
Link copied to clipboard
val second: B

Second value.

Since Kotlin 1.1
val second: B

Second value.

Since Kotlin 1.0

Functions

Link copied to clipboard
fun <T> Pair<T, T>.toList(): List<T>

Converts this pair into a list.

Since Kotlin 1.1
fun <T> Pair<T, T>.toList(): List<T>

Converts this pair into a list.

Since Kotlin 1.0
Link copied to clipboard
open override fun toString(): String

Returns string representation of the Pair including its first and second values.

Since Kotlin 1.1
open override fun toString(): String

Returns string representation of the Pair including its first and second values.

Since Kotlin 1.0