コレクションの変更
ミュータブル(可変)コレクションは、要素の追加や削除など、コレクションの内容を変更するための操作をサポートしています。 このページでは、MutableCollection のすべての実装で利用可能な書き込み操作について説明します。 List および Map で利用可能なより具体的な操作については、それぞれList固有の操作およびMap固有の操作を参照してください。
要素の追加
リストまたはセットに単一の要素を追加するには、add() 関数を使用します。指定されたオブジェクトはコレクションの末尾に追加されます。
fun main() {
val numbers = mutableListOf(1, 2, 3, 4)
numbers.add(5)
println(numbers)
}addAll() は、引数オブジェクトのすべての要素をリストまたはセットに追加します。引数には Iterable、Sequence、または Array を指定できます。 レシーバーと引数の型が異なっていても構いません。例えば、Set のすべての項目を List に追加できます。
リストに対して呼び出された場合、addAll() は引数内にあるのと同じ順序で新しい要素を追加します。 また、最初の引数として要素の位置(インデックス)を指定して addAll() を呼び出すこともできます。 引数コレクションの最初の要素がこの位置に挿入されます。 引数コレクションの他の要素がその後に続き、レシーバーの元の要素は後ろにシフトされます。
fun main() {
val numbers = mutableListOf(1, 2, 5, 6)
numbers.addAll(arrayOf(7, 8))
println(numbers)
numbers.addAll(2, setOf(3, 4))
println(numbers)
}また、plus 演算子のインプレース(in-place)バージョンである plusAssign (+=) を使用して要素を追加することもできます。 ミュータブルコレクションに適用すると、+= は2番目のオペランド(要素または別のコレクション)をコレクションの末尾に追加します。
fun main() {
val numbers = mutableListOf("one", "two")
numbers += "three"
println(numbers)
numbers += listOf("four", "five")
println(numbers)
}要素の削除
ミュータブルコレクションから要素を削除するには、remove() 関数を使用します。 remove() は要素の値を受け取り、その値に一致するものを1つ削除します。
fun main() {
val numbers = mutableListOf(1, 2, 3, 4, 3)
numbers.remove(3) // 最初の `3` を削除
println(numbers)
numbers.remove(5) // 何も削除しない
println(numbers)
}一度に複数の要素を削除するために、以下の関数が用意されています。
removeAll()は、引数コレクションに存在するすべての要素を削除します。 あるいは、述語(predicate)を引数として呼び出すこともできます。この場合、関数は述語がtrueを返す全ての要素を削除します。retainAll()はremoveAll()の逆です。引数コレクションに含まれる要素以外のすべての要素を削除します。 述語と共に使用した場合、それに一致する要素のみを残します。clear()はリストからすべての要素を削除し、空にします。
fun main() {
val numbers = mutableListOf(1, 2, 3, 4)
println(numbers)
numbers.retainAll { it >= 3 }
println(numbers)
numbers.clear()
println(numbers)
val numbersSet = mutableSetOf("one", "two", "three", "four")
numbersSet.removeAll(setOf("one", "two"))
println(numbersSet)
}コレクションから要素を削除するもう1つの方法は、minus のインプレースバージョンである minusAssign (-=) 演算子を使用することです。 2番目の引数には、要素型の単一インスタンスまたは別のコレクションを指定できます。 右辺に単一の要素を指定した場合、-= はその要素の最初に出現したものを削除します。 一方、コレクションである場合は、その要素に一致するすべての出現箇所が削除されます。 例えば、リストに重複する要素が含まれている場合、それらは一度に削除されます。 2番目のオペランドには、コレクション内に存在しない要素を含めることもできます。そのような要素は操作の実行に影響を与えません。
fun main() {
val numbers = mutableListOf("one", "two", "three", "three", "four")
numbers -= "three"
println(numbers)
numbers -= listOf("four", "five")
//numbers -= listOf("four") // 上記と同じ結果になる
println(numbers)
}要素の更新
リストとマップには、要素を更新するための操作も用意されています。 それらについては、List固有の操作およびMap固有の操作で説明されています。 セットの場合、更新は実質的に要素を削除して別の要素を追加することになるため、更新操作は意味を持ちません。
