kotlin-stdlib/kotlin.collections/getOrNull

getOrNull

fun <T> Array<out T>.getOrNull(index: Int): T?

fun ByteArray.getOrNull(index: Int): Byte?

fun ShortArray.getOrNull(index: Int): Short?

fun IntArray.getOrNull(index: Int): Int?

fun LongArray.getOrNull(index: Int): Long?

fun FloatArray.getOrNull(index: Int): Float?

fun DoubleArray.getOrNull(index: Int): Double?

fun BooleanArray.getOrNull(index: Int): Boolean?

fun CharArray.getOrNull(index: Int): Char?

Returns an element at the given index or null if the index is out of bounds of this array.

Samples

import samples.*
import kotlin.test.*
fun main() { 
   //sampleStart 
   val list = listOf(1, 2, 3)
assertPrints(list.getOrNull(0), "1")
assertPrints(list.getOrNull(2), "3")
assertPrints(list.getOrNull(3), "null")

val emptyList = emptyList<Int>()
assertPrints(emptyList.getOrNull(0), "null") 
   //sampleEnd
}

fun <T> List<T>.getOrNull(index: Int): T?

Returns an element at the given index or null if the index is out of bounds of this list.

Samples

import samples.*
import kotlin.test.*
fun main() { 
   //sampleStart 
   val list = listOf(1, 2, 3)
assertPrints(list.getOrNull(0), "1")
assertPrints(list.getOrNull(2), "3")
assertPrints(list.getOrNull(3), "null")

val emptyList = emptyList<Int>()
assertPrints(emptyList.getOrNull(0), "null") 
   //sampleEnd
}

@ExperimentalUnsignedTypes

fun UIntArray.getOrNull(index: Int): UInt?

@ExperimentalUnsignedTypes

fun ULongArray.getOrNull(index: Int): ULong?

@ExperimentalUnsignedTypes

fun UByteArray.getOrNull(index: Int): UByte?

@ExperimentalUnsignedTypes

fun UShortArray.getOrNull(index: Int): UShort?

Returns an element at the given index or null if the index is out of bounds of this array.

Since Kotlin

1.3

Samples

import samples.*
import kotlin.test.*
fun main() { 
   //sampleStart 
   val list = listOf(1, 2, 3)
assertPrints(list.getOrNull(0), "1")
assertPrints(list.getOrNull(2), "3")
assertPrints(list.getOrNull(3), "null")

val emptyList = emptyList<Int>()
assertPrints(emptyList.getOrNull(0), "null") 
   //sampleEnd
}