Months

value class Months(value: Long) : Comparable<Months>

Constructors

Months
Link copied to clipboard
common
fun Months(value: Int)

Types

Companion
Link copied to clipboard
common
object Companion

Functions

compareTo
Link copied to clipboard
common
open operator override fun compareTo(other: Months): Int
div
Link copied to clipboard
common
operator fun div(scalar: Int): Months
operator fun div(scalar: Long): Months

Returns this duration divided by a scalar value. @throws ArithmeticException if overflow occurs or the scalar is zero

minus
Link copied to clipboard
common
operator fun minus(centuries: Centuries): Months
operator fun minus(decades: Decades): Months
operator fun minus(months: Months): Months
operator fun minus(years: Years): Months
plus
Link copied to clipboard
common
operator fun plus(centuries: Centuries): Months
operator fun plus(decades: Decades): Months
operator fun plus(months: Months): Months
operator fun plus(years: Years): Months
rem
Link copied to clipboard
common
operator fun rem(scalar: Int): Months
operator fun rem(scalar: Long): Months

Returns the remainder of this duration divided by a scalar value.

times
Link copied to clipboard
common
operator fun times(scalar: Int): Months
operator fun times(scalar: Long): Months

Multiplies this duration by a scalar value. @throws ArithmeticException if overflow occurs

toComponents
Link copied to clipboard
common
inline fun <T> toComponents(action: (years: Years, months: Months) -> T): T
inline fun <T> toComponents(action: (decades: Decades, years: Years, months: Months) -> T): T
inline fun <T> toComponents(action: (centuries: Centuries, decades: Decades, years: Years, months: Months) -> T): T
toComponentValues
Link copied to clipboard
common
inline fun <T> toComponentValues(action: (years: Long, months: Int) -> T): T
inline fun <T> toComponentValues(action: (decades: Long, years: Int, months: Int) -> T): T
inline fun <T> toComponentValues(action: (centuries: Long, decades: Int, years: Int, months: Int) -> T): T
toDouble
Link copied to clipboard
common
fun toDouble(): Double

Converts this duration to a Double value.

toInt
Link copied to clipboard
common
fun toInt(): Int

Converts this duration to an Int value. @throws ArithmeticException if overflow occurs

toLong
Link copied to clipboard
common
fun toLong(): Long

Converts this duration to a Long value.

toString
Link copied to clipboard
common
open override fun toString(): String

Converts this duration to an ISO-8601 time interval representation.

unaryMinus
Link copied to clipboard
common
operator fun unaryMinus(): Months

Negates this duration. @throws ArithmeticException if overflow occurs

Properties

absoluteValue
Link copied to clipboard
common
val absoluteValue: Months

The absolute value of this duration. @throws ArithmeticException if overflow occurs

inWholeCenturies
Link copied to clipboard
common
val inWholeCenturies: Centuries

Converts this duration to the number of whole centuries.

inWholeDecades
Link copied to clipboard
common
val inWholeDecades: Decades

Converts this duration to the number of whole decades.

inWholeYears
Link copied to clipboard
common
val inWholeYears: Years

Converts this duration to the number of whole years.

value
Link copied to clipboard
common
val value: Long

The underlying value.

Extensions

asPeriod
Link copied to clipboard
common
fun Months.asPeriod(): Period

Converts this duration into a Period with the same number of months.

minus
Link copied to clipboard
common
operator fun Months.minus(period: Period): Period
plus
Link copied to clipboard
common
operator fun Months.plus(period: Period): Period
toJavaPeriod
Link copied to clipboard
fun Months.toJavaPeriod(): Period

Converts this duration to an equivalent Java Period.