W3cubDocs

/Kotlin

Pair

data class Pair<out A, out B> : Serializable

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:

import kotlin.test.*

fun main(args: Array<String>) {
//sampleStart
val (a, b) = Pair(1, "x")
println(a) // 1
println(b) // x
//sampleEnd
}

Parameters

A - type of the first value.

B - type of the second value.

Constructors

<init>

Pair(first: A, second: B)

Creates a new instance of Pair.

Properties

first

val first: A

First value.

second

val second: B

Second value.

Functions

toString

fun toString(): String

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

Extension Functions

toList

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

Converts this pair into a list.

© 2010–2017 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/