core / io.islandtime.measures / IntMonths

IntMonths

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) inline class IntMonths : Comparable<IntMonths>

A number of months.

Constructors

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

<init>

A number of months.

<init>(value: Int)

Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) absoluteValue	Returns the absolute value. `val absoluteValue: IntMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) inCenturies	Convert to whole centuries. `val inCenturies: IntCenturies`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) inDecades	Convert to whole decades. `val inDecades: IntDecades`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) inYears	Convert to whole years. `val inYears: IntYears`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) value	The underlying value. `val value: Int`

Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) compareTo	`fun compareTo(other: IntMonths): Int`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) div	Divide by a scalar value. `operator fun div(scalar: Int): IntMonths` `operator fun div(scalar: Long): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) isNegative	Is this duration negative? `fun isNegative(): Boolean`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) isPositive	Is this duration positive? `fun isPositive(): Boolean`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) isZero	Is this duration zero? `fun isZero(): Boolean`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) minus	`operator fun minus(months: IntMonths): IntMonths` `operator fun minus(months: LongMonths): LongMonths` `operator fun minus(years: IntYears): IntMonths` `operator fun minus(years: LongYears): LongMonths` `operator fun minus(decades: IntDecades): IntMonths` `operator fun minus(decades: LongDecades): LongMonths` `operator fun minus(centuries: IntCenturies): IntMonths` `operator fun minus(centuries: LongCenturies): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) plus	`operator fun plus(months: IntMonths): IntMonths` `operator fun plus(months: LongMonths): LongMonths` `operator fun plus(years: IntYears): IntMonths` `operator fun plus(years: LongYears): LongMonths` `operator fun plus(decades: IntDecades): IntMonths` `operator fun plus(decades: LongDecades): LongMonths` `operator fun plus(centuries: IntCenturies): IntMonths` `operator fun plus(centuries: LongCenturies): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) rem	`operator fun rem(scalar: Int): IntMonths` `operator fun rem(scalar: Long): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) times	Multiply by a scalar value. `operator fun times(scalar: Int): IntMonths` `operator fun times(scalar: Long): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) toComponents	`fun <T> toComponents(action: (years: IntYears, months: IntMonths) -> T): T` `fun <T> toComponents(action: (decades: IntDecades, years: IntYears, months: IntMonths) -> T): T` `fun <T> toComponents(action: (centuries: IntCenturies, decades: IntDecades, years: IntYears, months: IntMonths) -> T): T`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) toLong	Convert to a unit-less `Long` value. `fun toLong(): Long`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) toLongMonths	Convert to LongMonths. `fun toLongMonths(): LongMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) toString	Convert to an ISO-8601 time interval representation. `fun toString(): String`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) unaryMinus	Negate the value. `operator fun unaryMinus(): IntMonths`

Companion Object Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MAX	The largest supported value. `val MAX: IntMonths`
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) MIN	The smallest supported value. `val MIN: IntMonths`

Extension Functions

(jvm)

toJavaPeriod

Convert to an equivalent Java Period.

fun IntMonths.toJavaPeriod(): Period