DateTimeInterval

common

fun DateTimeInterval(start: DateTime, endExclusive: DateTime)

Companion

common

asDuration

common

Converts this interval to the Duration between the start and end date-time, assuming they're in the same time zone. In general, it's more appropriate to calculate duration using Instant or ZonedDateTime as any daylight savings rules won't be taken into account when working with DateTime directly.

fun asDuration(): Duration

asPeriod

common

Converts this interval into a Period of the same length.

fun asPeriod(): Period

contains

common

Checks if this interval contains value.

open operator override fun contains(value: DateTime): Boolean

equals

common

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

hasBoundedEnd

common

Checks if this interval's end is bounded, meaning it has a finite value.

open override fun hasBoundedEnd(): Boolean

hasBoundedStart

common

Checks if this interval's start is bounded, meaning it has a finite value.

open override fun hasBoundedStart(): Boolean

hashCode

common

open override fun hashCode(): Int

hasUnboundedEnd

common

Checks if this interval's end is unbounded. In ISO-8601 terminology, this is an "open" end.

open override fun hasUnboundedEnd(): Boolean

hasUnboundedStart

common

Checks if this interval's start is unbounded. In ISO-8601 terminology, this is an "open" start.

open override fun hasUnboundedStart(): Boolean

isBounded

common

Checks if both the start and end of this interval are bounded, meaning it has a finite range.

open override fun isBounded(): Boolean

isEmpty

common

Checks if this interval is empty.

open override fun isEmpty(): Boolean

isUnbounded

common

Checks if both the start and end of this interval are unbounded, meaning this is an infinite time period in both directions.

open override fun isUnbounded(): Boolean

toString

common

Converts this interval to a string in ISO-8601 extended format.

open override fun toString(): String

endExclusive

common

The end of this interval, exclusive.

open override val endExclusive: DateTime

endInclusive

common

The end of this interval, inclusive.

open override val endInclusive: DateTime

lengthInDays

common

The number of whole days in this interval.

val lengthInDays: LongDays

lengthInHours

common

The number of whole hours in this interval.

val lengthInHours: LongHours

lengthInMicroseconds

common

The number of whole microseconds in this interval.

val lengthInMicroseconds: LongMicroseconds

lengthInMilliseconds

common

The number of whole milliseconds in this interval.

val lengthInMilliseconds: LongMilliseconds

lengthInMinutes

common

The number of whole minutes in this interval.

val lengthInMinutes: LongMinutes

lengthInMonths

common

The number of whole months in this interval.

val lengthInMonths: IntMonths

lengthInNanoseconds

common

The number of nanoseconds in this interval.

val lengthInNanoseconds: LongNanoseconds

lengthInSeconds

common

The number of whole seconds in this interval.

val lengthInSeconds: LongSeconds

lengthInWeeks

common

The number of whole weeks in this interval.

val lengthInWeeks: LongWeeks

lengthInYears

common

The number of whole years in this interval.

val lengthInYears: IntYears

start

common

The start of this interval, inclusive.

open override val start: DateTime

at

common

Combines this DateTimeInterval with a TimeZone to create a ZonedDateTimeInterval where both endpoints are in zone.

Due to daylight savings time transitions, there a few complexities to be aware of. If the local time of either endpoint falls within a gap (meaning it doesn't exist), it will be adjusted forward by the length of the gap. If it falls within an overlap (meaning the local time exists twice), the earlier offset will be used.

infix fun DateTimeInterval.at(zone: TimeZone): ZonedDateTimeInterval

random

common

Returns a random date within this interval using the default random number generator.

fun DateTimeInterval.random(): DateTime

Returns a random date within this interval using the supplied random number generator.

fun DateTimeInterval.random(random: Random): DateTime

randomOrNull

common

Returns a random date within this interval using the default random number generator or null if the interval is empty or unbounded.

fun DateTimeInterval.randomOrNull(): DateTime?

Returns a random date within this interval using the supplied random number generator or null if the interval is empty or unbounded.

fun DateTimeInterval.randomOrNull(random: Random): DateTime?

toDateRange

common

Returns this interval with the precision reduced to just the date.

fun DateTimeInterval.toDateRange(): DateRange

toInstantIntervalAt

common

Converts this interval to an InstantInterval where both endpoints are in zone.

Due to daylight savings time transitions, there a few complexities to be aware of. If the local time of either endpoint falls within a gap (meaning it doesn't exist), it will be adjusted forward by the length of the gap. If it falls within an overlap (meaning the local time exists twice), the earlier offset will be used.

fun DateTimeInterval.toInstantIntervalAt(zone: TimeZone): InstantInterval

DateTimeInterval

Constructors

Types

Functions

Properties

Extensions