kotlin-stdlib/kotlin/requireNotNull

requireNotNull

inline fun <T : Any> requireNotNull(value: T?): T(source)

Throws an IllegalArgumentException if the value is null. Otherwise returns the not null value.

Since Kotlin

1.1
inline fun <T : Any> requireNotNull(value: T?, lazyMessage: () -> Any): T(source)

Throws an IllegalArgumentException with the result of calling lazyMessage if the value is null. Otherwise returns the not null value.

Since Kotlin

1.1

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   fun printRequiredParam(params: Map<String, String?>) {
    val required: String = requireNotNull(params["required"]) { "Required value must be non-null" } // returns a non-null value
    println(required)
    // ...
}

fun printRequiredParamByUpperCase(params: Map<String, String?>) {
    val requiredParam: String? = params["required"]
    requireNotNull(requiredParam) { "Required value must be non-null" }
    // now requiredParam is smartcast to String so that it is unnecessary to use the safe call(?.)
    println(requiredParam.uppercase())
}

val params: MutableMap<String, String?> = mutableMapOf("required" to null)
// printRequiredParam(params) // will fail with IllegalArgumentException
// printRequiredParamByUpperCase(params) // will fail with IllegalArgumentException

params["required"] = "non-empty-param"
printRequiredParam(params) // prints "non-empty-param"
printRequiredParamByUpperCase(params) // prints "NON-EMPTY-PARAM" 
   //sampleEnd
}
inline fun <T : Any> requireNotNull(value: T?): T(source)

Throws an IllegalArgumentException if the value is null. Otherwise returns the not null value.

Since Kotlin

1.0
inline fun <T : Any> requireNotNull(value: T?, lazyMessage: () -> Any): T(source)

Throws an IllegalArgumentException with the result of calling lazyMessage if the value is null. Otherwise returns the not null value.

Since Kotlin

1.0

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   fun printRequiredParam(params: Map<String, String?>) {
    val required: String = requireNotNull(params["required"]) { "Required value must be non-null" } // returns a non-null value
    println(required)
    // ...
}

fun printRequiredParamByUpperCase(params: Map<String, String?>) {
    val requiredParam: String? = params["required"]
    requireNotNull(requiredParam) { "Required value must be non-null" }
    // now requiredParam is smartcast to String so that it is unnecessary to use the safe call(?.)
    println(requiredParam.uppercase())
}

val params: MutableMap<String, String?> = mutableMapOf("required" to null)
// printRequiredParam(params) // will fail with IllegalArgumentException
// printRequiredParamByUpperCase(params) // will fail with IllegalArgumentException

params["required"] = "non-empty-param"
printRequiredParam(params) // prints "non-empty-param"
printRequiredParamByUpperCase(params) // prints "NON-EMPTY-PARAM" 
   //sampleEnd
}