//core/io.islandtime.measures/LongMonths

LongMonths

A number of months.

inline class LongMonths(value: Long) : Comparable<LongMonths>

Constructors

LongMonths

common

fun LongMonths(value: Long)

Types

Companion

common

object Companion

Functions

compareTo

common

open operator override fun compareTo(other: LongMonths): Int

div

common

Divides this duration by a scalar value.

operator fun div(scalar: Int): LongMonths

operator fun div(scalar: Long): LongMonths

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

isNegative

common

Checks if this duration is negative.

fun isNegative(): Boolean

isPositive

common

Checks if this duration is positive.

fun isPositive(): Boolean

isZero

common

Checks if this duration is zero.

fun isZero(): Boolean

minus

common

operator fun minus(months: IntMonths): LongMonths

operator fun minus(months: LongMonths): LongMonths

operator fun minus(years: IntYears): LongMonths

operator fun minus(years: LongYears): LongMonths

operator fun minus(decades: IntDecades): LongMonths

operator fun minus(decades: LongDecades): LongMonths

operator fun minus(centuries: IntCenturies): LongMonths

operator fun minus(centuries: LongCenturies): LongMonths

plus

common

operator fun plus(months: IntMonths): LongMonths

operator fun plus(months: LongMonths): LongMonths

operator fun plus(years: IntYears): LongMonths

operator fun plus(years: LongYears): LongMonths

operator fun plus(decades: IntDecades): LongMonths

operator fun plus(decades: LongDecades): LongMonths

operator fun plus(centuries: IntCenturies): LongMonths

operator fun plus(centuries: LongCenturies): LongMonths

rem

common

operator fun rem(scalar: Int): LongMonths

operator fun rem(scalar: Long): LongMonths

times

common

Multiplies this duration by a scalar value.

operator fun times(scalar: Int): LongMonths

operator fun times(scalar: Long): LongMonths

toComponents

common

inline fun <T> toComponents(action: (LongYears, IntMonths) -> T): T

inline fun <T> toComponents(action: (LongDecades, IntYears, IntMonths) -> T): T

inline fun <T> toComponents(action: (LongCenturies, IntDecades, IntYears, IntMonths) -> T): T

toInt

common

Converts this duration to an Int value.

fun toInt(): Int

toIntMonths

common

Converts this duration to IntMonths.

fun toIntMonths(): IntMonths

toString

common

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

open override fun toString(): String

unaryMinus

common

Negates this duration.

operator fun unaryMinus(): LongMonths

Properties

absoluteValue

common

The absolute value of this duration.

val absoluteValue: LongMonths

inCenturies

common

Converts this duration to the number of whole centuries.

val inCenturies: LongCenturies

inDecades

common

Converts this duration to the number of whole decades.

val inDecades: LongDecades

inYears

common

Converts this duration to the number of whole years.

val inYears: LongYears

value

common

The underlying value.

val value: Long

Extensions

asPeriod

common

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

fun LongMonths.asPeriod(): Period

minus

common

operator fun LongMonths.minus(period: Period): Period

plus

common

operator fun LongMonths.plus(period: Period): Period

toJavaPeriod

jvm

Converts this duration to an equivalent Java Period.

fun LongMonths.toJavaPeriod(): Period