単一要素の取得
Kotlinのコレクションには、コレクションから単一の要素を取得するための一連の関数が用意されています。 このページで説明する関数は、リストとセット(Set)の両方に適用されます。
リストの定義にあるように、リストは順序を持つ(ordered)コレクションです。 そのため、リストのすべての要素には参照に使用できる位置が存在します。 このページで説明する関数に加えて、リストにはインデックスによって要素を取得・検索するためのより広範な手段が用意されています。 詳細については、リスト特有の操作を参照してください。
一方、セットは定義上は順序を持つコレクションではありません。 しかし、Kotlinの Set は特定の順序で要素を格納します。 これは挿入順(LinkedHashSet の場合)、自然順序(SortedSet の場合)、あるいはその他の順序の場合があります。 セットの要素の順序が不明な場合もあります。 そのような場合でも要素は何らかの形で順序付けられているため、要素の位置に依存する関数は依然として結果を返します。 ただし、使用されている具体的な Set の実装を把握していない限り、呼び出し側にとってその結果は予測不能となります。
位置による取得
特定の位置にある要素を取得するために、elementAt() 関数が用意されています。 整数を引数として呼び出すと、指定された位置にあるコレクションの要素が返されます。 最初の要素の位置は 0 であり、最後の要素の位置は (size - 1) です。
elementAt() は、インデックス付きアクセスを提供していないコレクションや、静的にそれを提供しているかどうかが不明なコレクションに対して便利です。 List の場合は、インデックスアクセス演算子(get() または [])を使用する方がよりイディオマティック(Kotlinらしい書き方)です。
fun main() {
val numbers = linkedSetOf("one", "two", "three", "four", "five")
println(numbers.elementAt(3))
val numbersSortedSet = sortedSetOf("one", "two", "three", "four")
println(numbersSortedSet.elementAt(0)) // 要素は昇順で格納されている
}また、コレクションの最初と最後の要素を取得するための便利なエイリアスとして、first() と last() もあります。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five")
println(numbers.first())
println(numbers.last())
}存在しない位置の要素を取得する際の例外を回避するには、elementAt() の安全なバリエーションを使用します:
elementAtOrNull()は、指定された位置がコレクションの範囲外である場合に null を返します。elementAtOrElse()は追加で、Intの引数をコレクションの要素型のインスタンスにマッピングするラムダ関数を受け取ります。 範囲外の位置で呼び出された場合、elementAtOrElse()は指定された値に対するラムダの結果を返します。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five")
println(numbers.elementAtOrNull(5))
println(numbers.elementAtOrElse(5) { index -> "The value for index $index is undefined"})
}条件による取得
first() および last() 関数を使用すると、指定された述語(predicate)に一致する要素をコレクションから検索することもできます。コレクションの要素をテストする述語を指定して first() を呼び出すと、その述語が true を返す最初の要素が取得されます。 同様に、述語を指定して last() を呼び出すと、それに一致する最後の要素が返されます。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five", "six")
println(numbers.first { it.length > 3 })
println(numbers.last { it.startsWith("f") })
}述語に一致する要素がない場合、どちらの関数も例外をスローします。 それを防ぐには、代わりに firstOrNull() および lastOrNull() を使用してください。 一致する要素が見つからない場合は null を返します。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five", "six")
println(numbers.firstOrNull { it.length > 6 })
}用途に合わせて名前がより適している場合は、エイリアスを使用できます:
firstOrNull()の代わりにfind()lastOrNull()の代わりにfindLast()
fun main() {
val numbers = listOf(1, 2, 3, 4)
println(numbers.find { it % 2 == 0 })
println(numbers.findLast { it % 2 == 0 })
}セレクターによる取得
要素を取得する前にコレクションを変換(マッピング)する必要がある場合は、firstNotNullOf() 関数を使用します。 これは以下の2つの処理を組み合わせたものです:
- セレクター関数でコレクションをマッピングする
- 結果の中から最初の null 以外の値を返す
firstNotNullOf() は、結果のコレクションに非 null 要素がない場合、NoSuchElementException をスローします。 この場合に null を返したい場合は、対応する firstNotNullOfOrNull() を使用してください。
fun main() {
val list = listOf<Any>(0, "true", false)
// 各要素を文字列に変換し、必要な長さを持つ最初の要素を返す
val longEnough = list.firstNotNullOf { item -> item.toString().takeIf { it.length >= 4 } }
println(longEnough)
}ランダムな要素
コレクションの任意の要素を取得する必要がある場合は、random() 関数を呼び出します。 引数なしで呼び出すことも、乱数生成元として Random オブジェクトを指定して呼び出すこともできます。
fun main() {
val numbers = listOf(1, 2, 3, 4)
println(numbers.random())
}空のコレクションに対して random() を呼び出すと例外がスローされます。代わりに null を受け取るには、randomOrNull() を使用してください。
要素の存在確認
コレクション内にある要素が存在するかどうかを確認するには、contains() 関数を使用します。 関数の引数と equals() で一致するコレクション要素が存在する場合、true を返します。 contains() は in キーワードを使用した演算子形式で呼び出すこともできます。
複数のインスタンスが一度に存在するかどうかを確認するには、それらのインスタンスのコレクションを引数として containsAll() を呼び出します。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five", "six")
println(numbers.contains("four"))
println("zero" in numbers)
println(numbers.containsAll(listOf("four", "two")))
println(numbers.containsAll(listOf("one", "zero")))
}さらに、コレクションに要素が含まれているかどうかは、isEmpty() または isNotEmpty() を呼び出すことで確認できます。
fun main() {
val numbers = listOf("one", "two", "three", "four", "five", "six")
println(numbers.isEmpty())
println(numbers.isNotEmpty())
val empty = emptyList<String>()
println(empty.isEmpty())
println(empty.isNotEmpty())
}