Skip to content

//core/io.islandtime.measures/Decades

Decades

common

@JvmInline

value class Decades(val value: Long) : Comparable<Decades>

Constructors

Decades

common

constructor(value: Int)

constructor(value: Long)

Types

Name Summary
Companion

common


object Companion

Properties

Name Summary
absoluteValue

common


val absoluteValue: Decades

The absolute value of this duration.
inMonths

common


val inMonths: Months

Converts this duration to months.
inWholeCenturies

common


val inWholeCenturies: Centuries

Converts this duration to the number of whole centuries.
inYears

common


val inYears: Years

Converts this duration to years.
value

common


val value: Long

The underlying value.

Functions

Name Summary
compareTo

common


open operator override fun compareTo(other: Decades): Int
div

common


operator fun div(scalar: Int): Decades

operator fun div(scalar: Long): Decades

Returns this duration divided by a scalar value.
minus

common


operator fun minus(centuries: Centuries): Decades

operator fun minus(decades: Decades): Decades

operator fun minus(months: Months): Months

operator fun minus(years: Years): Years
plus

common


operator fun plus(centuries: Centuries): Decades

operator fun plus(decades: Decades): Decades

operator fun plus(months: Months): Months

operator fun plus(years: Years): Years
rem

common


operator fun rem(scalar: Int): Decades

operator fun rem(scalar: Long): Decades

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

common


operator fun times(scalar: Int): Decades

operator fun times(scalar: Long): Decades

Multiplies this duration by a scalar value.
toComponents

common


inline fun <T> toComponents(action: (centuries: Centuries, decades: Decades) -> T): T
toComponentValues

common


inline fun <T> toComponentValues(action: (centuries: Long, decades: Int) -> T): T
toDouble

common


fun toDouble(): Double

Converts this duration to a Double value.
toInt

common


fun toInt(): Int

Converts this duration to an Int value.
toJavaPeriod

jvm


fun Decades.toJavaPeriod(): Period

Converts this duration to an equivalent Java Period.
toLong

common


fun toLong(): Long

Converts this duration to a Long value.
toString

common


open override fun toString(): String

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

common


operator fun unaryMinus(): Decades

Negates this duration.