types/org.kotools.types.number/NonNegativeInteger/Companion/fromLongOrNull

fromLongOrNull

fun fromLongOrNull(value: Long): NonNegativeInteger?

Returns a NonNegativeInteger representing the specified value, or returns null if value is negative.

Calling from Kotlin

Here's an example of calling this function from Kotlin code:

val result: NonNegativeInteger = NonNegativeInteger.fromLong(42)
check("$result" == "42")

val exception: Throwable? =
    runCatching { NonNegativeInteger.fromLong(-1) }.exceptionOrNull()
check(exception is IllegalArgumentException)

val safeResult: NonNegativeInteger? =
    NonNegativeInteger.fromLongOrNull(-1)
check(safeResult == null)

This function is hidden from Java, because nullability is not explicit in its type system.

See the fromLong function for throwing an exception instead of returning null when value is negative.