core / io.islandtime.measures / IntWeeks

IntWeeks

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

A number of weeks.

Constructors

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

<init>

A number of weeks.

<init>(value: Int)

Properties

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

absoluteValue

Returns the absolute value.

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

inDays

Convert to days.

val inDays: IntDays
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

value

The underlying value.

val value: Int

Functions

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

compareTo

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

div

Divide by a scalar value.

operator fun div(scalar: Int): IntWeeks
operator fun div(scalar: Long): LongWeeks
(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(days: IntDays): IntDays
operator fun minus(days: LongDays): LongDays
operator fun minus(weeks: IntWeeks): IntWeeks
operator fun minus(weeks: LongWeeks): LongWeeks
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

plus

operator fun plus(days: IntDays): IntDays
operator fun plus(days: LongDays): LongDays
operator fun plus(weeks: IntWeeks): IntWeeks
operator fun plus(weeks: LongWeeks): LongWeeks
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

rem

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

times

Multiply by a scalar value.

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

toLong

Convert to a unit-less Long value.

fun toLong(): Long
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

toLongWeeks

Convert to LongWeeks.

fun toLongWeeks(): LongWeeks
(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(): IntWeeks

Companion Object Properties

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

MAX

The largest supported value.

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

MIN

The smallest supported value.

val MIN: IntWeeks

Extension Functions

(jvm)

toJavaPeriod

Convert to an equivalent Java Period.

fun IntWeeks.toJavaPeriod(): Period