Kotlin - takeIf、takeUnless

公開日:2019-11-06 更新日:2019-11-06
[Kotlin]

1. 概要

takeIf は、指定した条件を満たす場合にレシーバー(呼び出し元のオブジェクト)を返し、条件を満たさない場合に null を返します。
takeUnless はその逆で、条件を満たす場合に null、満たさない場合にレシーバーを返します。


2. takeIf

基本的な動作
val list = arrayListOf(1, 2, 3)
println( list.takeIf { list.size > 0 } ) // [1, 2, 3]
println( list.takeIf { list.size > 9 } ) // null

レシーバーを返すため、apply、also、run、let などを続けて実行できます。
arrayListOf(1, 2, 3).takeIf { it.size > 0 }?.let {
    println(it) // [1, 2, 3]
}
下記は上記を if で書き直したものです。
もしこの処理のあとで list を使用しないのであれば、上記の方が良いかもしれません。
val list = arrayListOf(1, 2, 3)
if (list.size > 0) {
    println(list) // [1, 2, 3]
}

条件を満たさない場合は null を返すため、
エルビス演算子を使って、途中で処理を抜けたり、例外をスローすることもできます。
以下はあくまでも例で、メソッドチェーンにしない場合は、if で書いた方が良いと思います。
val list = arrayListOf(1, 2, 3)
list.takeIf { list.size == 0 } ?: throw Exception("エラー")
list.takeIf { list.size == 1 } ?: return
println("処理")


3. takeUnless

takeIf と逆の結果となります。
val list = arrayListOf(1, 2, 3)
println( list.takeUnless { list.size > 0 } ) // null
println( list.takeUnless { list.size > 9 } ) // [1, 2, 3]