Функция elementAtOrNull

Функция elementAtOrNull возвращает элемент коллекции по указанному индексу. Если индекс выходит за границы коллекции (меньше 0 или больше/равен размеру коллекции), функция возвращает null вместо выбрасывания исключения. Применяется к массивам, спискам, множествам и другим коллекциям.

Импорт

import kotlin.collections.elementAtOrNull

Синтаксис

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

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

fun <T> Iterable<T>.elementAtOrNull(index: Int): T?

Пример

Получим элемент по индексу из массива:

val arr = arrayOf('a', 'b', 'c', 'd', 'e')
val res = arr.elementAtOrNull(2)
println(res)

Результат выполнения кода:

Char 'c'

Пример

Попробуем получить элемент по несуществующему индексу из списка:

val list = listOf(1, 2, 3, 4, 5)
val res = list.elementAtOrNull(10)
println(res)

Результат выполнения кода:

null

Пример

Использование с множеством:

val set = setOf("apple", "banana", "cherry")
val res = set.elementAtOrNull(1)
println(res)

Результат выполнения кода:

String "banana"

Пример

Безопасная обработка результата с помощью оператора элвис:

val numbers = arrayOf(10, 20, 30)
val index = 5
val result = numbers.elementAtOrNull(index) ?: -1
println("Element at index $index: $result")

Результат выполнения кода:

Element at index 5: -1

Для каких типов коллекций работает

Функция elementAtOrNull работает со следующими типами коллекций:

Array - массивы
List - списки
Set - множества
Iterable - любые итерируемые коллекции
Sequence - последовательности
CharArray, IntArray, DoubleArray и другие примитивные массивы

Смотрите также

функцию elementAt,
которая выбрасывает исключение при неверном индексе
функцию elementAtOrElse,
которая возвращает значение по умолчанию при неверном индексе
функцию getOrNull,
которая является синонимом для elementAtOrNull
функцию firstOrNull,
которая возвращает первый элемент или null