Kotlin入門｜Mapの要素を削除する方法

KotlinでMapの要素を削除する方法について記載します。

Mapの要素を削除する方法

Mapの要素を削除するには、remove もしくは clear 関数を使用します。

1. キーに一致する要素を削除する（ remove ）

指定したキーに一致する要素を削除するには remove 関数を使用します。

戻り値には削除した要素の値が返されます。

書式

変数.remove( 削除するキー )

実行例

val mapStr1 = mutableMapOf(
    "key1" to "value1",
    "key2" to "value2",
    "key3" to "value3"
)

// キーに一致する要素がある場合、削除される
val return1 = mapStr1.remove("key2")

println( mapStr1 ) // {key1=value1, key3=value3}
println( return1 ) // value2

// キーに一致する要素がない場合、削除しない
val return2 = mapStr1.remove("key5")

println( mapStr1 ) // {key1=value1, key3=value3}
println( return2 ) // null

val mapStr1 = mutableMapOf(

"key1" to "value1",

"key2" to "value2",

"key3" to "value3"

)

// キーに一致する要素がある場合、削除される

val return1 = mapStr1.remove("key2")

println( mapStr1 ) // {key1=value1, key3=value3}

println( return1 ) // value2

// キーに一致する要素がない場合、削除しない

val return2 = mapStr1.remove("key5")

println( mapStr1 ) // {key1=value1, key3=value3}

println( return2 ) // null

2. キー・バリューに一致する要素を削除する（ remove ）

指定したキー・バリューに一致する要素を削除する場合も remove 関数を使用します。

戻り値に true（削除した）/ false（削除なし）を返します。

書式

変数.remove( 削除するキーとバリューのペア )

実行例

val mapStr2 = mutableMapOf(
    "key1" to "value1",
    "key2" to "value2",
    "key3" to "value3"
)

// key-valueに一致する要素がない場合、削除しない
val return3 = mapStr2.remove( "key2", "value3" )

println( mapStr2 ) // {key1=value1, key2=value2, key3=value3}
println( return3 ) // false

// key-valueに一致する要素があるので、削除される
val return4 = mapStr2.remove( "key2", "value2" )

println( mapStr2 ) // {key1=value1, key3=value3}
println( return4 ) // true

val mapStr2 = mutableMapOf(

"key1" to "value1",

"key2" to "value2",

"key3" to "value3"

)

// key-valueに一致する要素がない場合、削除しない

val return3 = mapStr2.remove( "key2", "value3" )

println( mapStr2 ) // {key1=value1, key2=value2, key3=value3}

println( return3 ) // false

// key-valueに一致する要素があるので、削除される

val return4 = mapStr2.remove( "key2", "value2" )

println( mapStr2 ) // {key1=value1, key3=value3}

println( return4 ) // true

3. 全ての要素を削除する（ clear ）

全ての要素を削除するには、clear 関数を使用します。

書式

変数.clear()

実行例

val mapStr3 = mutableMapOf(
    "key1" to "value1",
    "key2" to "value2",
    "key3" to "value3"
)

mapStr3.clear()

println( mapStr3 ) // {}

val mapStr3 = mutableMapOf(

"key1" to "value1",

"key2" to "value2",

"key3" to "value3"

)

mapStr3.clear()

println( mapStr3 ) // {}