Period

class Period

A date-based period of time, such as "2 years, 5 months, 16 days". Unlike Duration, which uses exact increments, a Period works with conceptual days, months, and years, ignoring daylight savings and length differences.

Types

Companion

common

object Companion

Functions

component1

common

operator fun component1(): IntYears

component2

common

operator fun component2(): IntMonths

component3

common

operator fun component3(): IntDays

copy

common

fun copy(years: IntYears = this.years, months: IntMonths = this.months, days: IntDays = this.days): Period

Returns a new Period, replacing the years, months, and days components with new values, as desired

equals

common

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

hashCode

common

open override fun hashCode(): Int

isNegative

common

fun isNegative(): Boolean

Checks if any component of this period is negative.

isZero

common

fun isZero(): Boolean

Checks if this period is zero.

minus

common

operator fun minus(days: IntDays): Period

operator fun minus(months: IntMonths): Period

operator fun minus(weeks: IntWeeks): Period

operator fun minus(years: IntYears): Period

operator fun minus(days: LongDays): Period

operator fun minus(months: LongMonths): Period

operator fun minus(weeks: LongWeeks): Period

operator fun minus(years: LongYears): Period

operator fun minus(other: Period): Period

Subtracts each component of another period from this period.

normalized

common

fun normalized(): Period

Normalizes the number of years and months such that "1 year, 15 months" becomes "2 years, 3 months".

plus

common

operator fun plus(days: IntDays): Period

operator fun plus(months: IntMonths): Period

operator fun plus(weeks: IntWeeks): Period

operator fun plus(years: IntYears): Period

operator fun plus(days: LongDays): Period

operator fun plus(months: LongMonths): Period

operator fun plus(weeks: LongWeeks): Period

operator fun plus(years: LongYears): Period

operator fun plus(other: Period): Period

Adds each component of another period to each component of this period.

times

common

operator fun times(scalar: Int): Period

Multiplies each component of this period by a scalar value.

toString

common

open override fun toString(): String

Returns an ISO-8601 duration representation, such as "P1Y10M3D".

unaryMinus

common

operator fun unaryMinus(): Period

Reverses the sign of each component in the period.

Properties

days

common

val days: IntDays

The number of days in this period.

months

common

val months: IntMonths

The number of months in this period.

totalMonths

common

val totalMonths: LongMonths

The total number of months in this period, including years.

years

common

val years: IntYears

The number of years in this period.

Extensions

toJavaPeriod

jvm

fun Period.toJavaPeriod(): Period

Converts this period to an equivalent Java Period.