core / io.islandtime.measures / LongDecades

LongDecades

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

A number of decades.

Constructors

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

<init>

A number of decades.

<init>(value: Long)

Properties

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

absoluteValue

Returns the absolute value.

val absoluteValue: LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

inCenturies

Convert to whole centuries.

val inCenturies: LongCenturies
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

inMonths

Convert to months.

val inMonths: LongMonths
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

inYears

Convert to years.

val inYears: LongYears
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

value

The underlying value.

val value: Long

Functions

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

compareTo

fun compareTo(other: LongDecades): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

div

Divide by a scalar value.

operator fun div(scalar: Int): LongDecades
operator fun div(scalar: Long): LongDecades
(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): LongMonths
operator fun minus(months: LongMonths): LongMonths
operator fun minus(years: IntYears): LongYears
operator fun minus(years: LongYears): LongYears
operator fun minus(decades: IntDecades): LongDecades
operator fun minus(decades: LongDecades): LongDecades
operator fun minus(centuries: IntCenturies): LongDecades
operator fun minus(centuries: LongCenturies): LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

plus

operator fun plus(months: IntMonths): LongMonths
operator fun plus(months: LongMonths): LongMonths
operator fun plus(years: IntYears): LongYears
operator fun plus(years: LongYears): LongYears
operator fun plus(decades: IntDecades): LongDecades
operator fun plus(decades: LongDecades): LongDecades
operator fun plus(centuries: IntCenturies): LongDecades
operator fun plus(centuries: LongCenturies): LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

rem

operator fun rem(scalar: Int): LongDecades
operator fun rem(scalar: Long): LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

times

Multiply by a scalar value.

operator fun times(scalar: Int): LongDecades
operator fun times(scalar: Long): LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

toComponents

fun <T> toComponents(action: (centuries: LongCenturies, decades: IntDecades) -> T): T
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

toInt

Convert to a unit-less Int value.

fun toInt(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

toIntDecades

Convert to IntDecades.

fun toIntDecades(): IntDecades
(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(): LongDecades

Companion Object Properties

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

MAX

The largest supported value.

val MAX: LongDecades
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

MIN

The smallest supported value.

val MIN: LongDecades

Extension Functions

(jvm)

toJavaPeriod

Convert to an equivalent Java Period.

fun LongDecades.toJavaPeriod(): Period