types/kotools.types.number/StrictlyPositiveInt/Companion/createOrNull

createOrNull

@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun createOrNull(number: Number): StrictlyPositiveInt?

Creates a StrictlyPositiveInt from the specified number, which may involve rounding or truncation, or returns null if the number is less than or equals zero.


Calling from Kotlin

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

val number: StrictlyPositiveInt? = StrictlyPositiveInt.createOrNull(42)
assertNotNull(number)
Content copied to clipboard

The StrictlyPositiveInt type being an inline value class, this function is not available yet for Java users.

You can use the StrictlyPositiveInt.Companion.create function for throwing an exception instead of returning null in case of invalid number.