types/kotools.types.number/StrictlyNegativeInt/Companion

Companion

object Companion

Contains declarations for holding or building a StrictlyNegativeInt.

Properties

Link copied to clipboard
val max: StrictlyNegativeInt

The maximum value a StrictlyNegativeInt can have.

Link copied to clipboard
val min: StrictlyNegativeInt

The minimum value a StrictlyNegativeInt can have.

Functions

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun create(number: Number): StrictlyNegativeInt

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

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun createOrNull(number: Number): StrictlyNegativeInt?

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

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

Returns a random StrictlyNegativeInt.