types/kotools.types.number/StrictlyPositiveInt/Companion/create

create

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

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


Calling from Kotlin

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

val isSuccess: Boolean = try {
    StrictlyPositiveInt.create(42)
    true
} catch (exception: IllegalArgumentException) {
    false
}
assertTrue(isSuccess)
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.createOrNull function for returning null instead of throwing an exception in case of invalid number.