Decades

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

Constructors

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

Types

Companion
Link copied to clipboard
common
object Companion

Functions

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

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): Decades
operator fun minus(decades: Decades): Decades
operator fun minus(months: Months): Months
operator fun minus(years: Years): Years
plus
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
common
operator fun times(scalar: Int): Decades
operator fun times(scalar: Long): Decades

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

toComponents
Link copied to clipboard
common
inline fun <T> toComponents(action: (centuries: Centuries, decades: Decades) -> T): T
toComponentValues
Link copied to clipboard
common
inline fun <T> toComponentValues(action: (centuries: Long, decades: 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(): Decades

Negates this duration. @throws ArithmeticException if overflow occurs

Properties

absoluteValue
Link copied to clipboard
common
val absoluteValue: Decades

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

inMonths
Link copied to clipboard
common
val inMonths: Months

Converts this duration to months. @throws ArithmeticException if overflow occurs

inWholeCenturies
Link copied to clipboard
common
val inWholeCenturies: Centuries

Converts this duration to the number of whole centuries.

inYears
Link copied to clipboard
common
val inYears: Years

Converts this duration to years. @throws ArithmeticException if overflow occurs

value
Link copied to clipboard
common
val value: Long

The underlying value.

Extensions

toJavaPeriod
Link copied to clipboard
fun Decades.toJavaPeriod(): Period

Converts this duration to an equivalent Java Period.