types/kotools.types.number/StrictlyPositiveInt/Companion

Companion

object Companion

Contains declarations for holding or building a StrictlyPositiveInt.

Properties

Link copied to clipboard
val max: StrictlyPositiveInt

The maximum value a StrictlyPositiveInt can have.

Link copied to clipboard
val min: StrictlyPositiveInt

The minimum value a StrictlyPositiveInt can have.

Functions

Link copied to clipboard
@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.

Link copied to clipboard
@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.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V3_0_0)
fun random(): StrictlyPositiveInt

Returns a random StrictlyPositiveInt.