コレクション操作の概要
Kotlin標準ライブラリは、コレクションに対する操作を実行するための多種多様な関数を提供しています。これには、要素の取得や追加といった単純な操作から、検索、ソート、フィルタリング、変換などのより複雑な操作までが含まれます。
拡張関数とメンバ関数
コレクション操作は、標準ライブラリにおいて2つの方法で宣言されています。コレクションインターフェースのメンバ関数と、拡張関数です。
メンバ関数は、コレクション型にとって本質的な操作を定義します。例えば、Collection には空であるかどうかをチェックするための isEmpty() 関数が含まれており、List には要素へのインデックスアクセスを行うための get() などが含まれています。
コレクションインターフェースの独自の実装を作成する場合は、それらのメンバ関数を実装する必要があります。新しい実装の作成を容易にするために、標準ライブラリが提供するコレクションインターフェースの骨格実装(skeletal implementations)を使用してください。具体的には AbstractCollection、AbstractList、AbstractSet、AbstractMap、およびそれらのミュータブル(可変)版があります。
その他のコレクション操作は拡張関数として宣言されています。これらには、フィルタリング、変換、順序付け、その他のコレクション処理関数が含まれます。
共通の操作
共通の操作は、読み取り専用コレクションとミュータブルコレクションの両方で利用できます。共通操作は以下のグループに分類されます。
これらのページで説明されている操作は、元のコレクションに影響を与えることなく結果を返します。例えば、フィルタリング操作は、フィルタ条件(プレディケート)に一致するすべての要素を含む新しいコレクションを生成します。このような操作の結果は、変数に格納するか、他の関数に渡すなど別の方法で使用する必要があります。
fun main() {
val numbers = listOf("one", "two", "three", "four")
numbers.filter { it.length > 3 } // numbers には何も起こらず、結果は失われます
println("numbers are still $numbers")
val longerThan3 = numbers.filter { it.length > 3 } // 結果は longerThan3 に格納されます
println("numbers longer than 3 chars are $longerThan3")
}一部のコレクション操作では、出力先(destination)オブジェクトを指定するオプションがあります。出力先とは、関数が結果のアイテムを新しいオブジェクトとして返すのではなく、結果を追加していくミュータブルコレクションのことです。出力先を指定して操作を実行するために、名前に接尾辞 To が付いた個別の関数が用意されています。例えば、filter() に対する filterTo() や、associate() に対する associateTo() などです。これらの関数は、追加のパラメータとして出力先コレクションを受け取ります。
fun main() {
val numbers = listOf("one", "two", "three", "four")
val filterResults = mutableListOf<String>() // 出力先オブジェクト
numbers.filterTo(filterResults) { it.length > 3 }
numbers.filterIndexedTo(filterResults) { index, _ -> index == 0 }
println(filterResults) // 両方の操作の結果が含まれます
}利便性のため、これらの関数は出力先コレクションを戻り値としても返すため、関数呼び出しの対応する引数の中で直接作成することができます。
fun main() {
val numbers = listOf("one", "two", "three", "four")
// numbers を新しい HashSet に直接フィルタリングし、
// 結果から重複を排除します
val result = numbers.mapTo(HashSet()) { it.length }
println("distinct item lengths are $result")
}出力先を指定できる関数は、フィルタリング、関連付け(association)、グループ化、平坦化(flattening)、その他の操作で利用できます。出力先操作の完全なリストについては、Kotlin コレクションリファレンスを参照してください。
書き込み操作
ミュータブルコレクションには、コレクションの状態を変更する書き込み操作(write operations)もあります。このような操作には、要素の追加、削除、更新が含まれます。書き込み操作は、書き込み操作および、List固有の操作やMap固有の操作の対応するセクションに記載されています。
特定の操作には、同じ処理を行う関数のペアが存在します。一方はインプレース(その場)で操作を適用し、もう一方は結果を別のコレクションとして返します。例えば、sort() はミュータブルコレクションをインプレースでソートするためその状態が変化しますが、sorted() は同じ要素をソートされた順序で含む新しいコレクションを作成します。
fun main() {
val numbers = mutableListOf("one", "two", "three", "four")
val sortedNumbers = numbers.sorted()
println(numbers == sortedNumbers) // false
numbers.sort()
println(numbers == sortedNumbers) // true
}