DateTimeInterval

class DateTimeInterval(start: DateTime, endExclusive: DateTime) : Interval<DateTime>

An interval between two date-times, assumed to be at the same offset from UTC.

DateTime.MIN and DateTime.MAX are used as sentinels to indicate an unbounded (ie. infinite) start or end.

Constructors

DateTimeInterval

common

fun DateTimeInterval(start: DateTime = UNBOUNDED.start, endExclusive: DateTime = UNBOUNDED.endExclusive)

Types

Companion

common

object Companion

Functions

asDuration

common

fun asDuration(): Duration

Converts this interval to the Duration between the start and end date-time, assuming they're in the same time zone.

asPeriod

common

fun asPeriod(): Period

Converts this interval into a Period of the same length.

contains

common

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

Checks if this interval contains value.

equals

common

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

hasBoundedEnd

common

open fun hasBoundedEnd(): Boolean

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

hasBoundedStart

common

open fun hasBoundedStart(): Boolean

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

hashCode

common

open override fun hashCode(): Int

hasUnboundedEnd

common

open override fun hasUnboundedEnd(): Boolean

Checks if this interval's end is unbounded.

hasUnboundedStart

common

open override fun hasUnboundedStart(): Boolean

Checks if this interval's start is unbounded.

isBounded

common

open fun isBounded(): Boolean

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

isEmpty

common

open override fun isEmpty(): Boolean

Checks if this interval is empty.

isUnbounded

common

open fun isUnbounded(): Boolean

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

toString

common

open override fun toString(): String

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

Properties

endExclusive

common

open override val endExclusive: DateTime

The end of this interval, exclusive.

endInclusive

common

open override val endInclusive: DateTime

The end of this interval, inclusive.

lengthInDays

common

val lengthInDays: LongDays

The number of whole days in this interval.

lengthInHours

common

val lengthInHours: LongHours

The number of whole hours in this interval.

lengthInMicroseconds

common

val lengthInMicroseconds: LongMicroseconds

The number of whole microseconds in this interval.

lengthInMilliseconds

common

val lengthInMilliseconds: LongMilliseconds

The number of whole milliseconds in this interval.

lengthInMinutes

common

val lengthInMinutes: LongMinutes

The number of whole minutes in this interval.

lengthInMonths

common

val lengthInMonths: IntMonths

The number of whole months in this interval.

lengthInNanoseconds

common

val lengthInNanoseconds: LongNanoseconds

The number of nanoseconds in this interval.

lengthInSeconds

common

val lengthInSeconds: LongSeconds

The number of whole seconds in this interval.

lengthInWeeks

common

val lengthInWeeks: LongWeeks

The number of whole weeks in this interval.

lengthInYears

common

val lengthInYears: IntYears

The number of whole years in this interval.

start

common

open override val start: DateTime

The start of this interval, inclusive.

Extensions

common

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

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

random

common

fun DateTimeInterval.random(): DateTime

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

fun DateTimeInterval.random(random: Random): DateTime

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

randomOrNull

common

fun DateTimeInterval.randomOrNull(): DateTime?

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(random: Random): DateTime?

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

toDateRange

common

fun DateTimeInterval.toDateRange(): DateRange

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

toInstantIntervalAt

common

fun DateTimeInterval.toInstantIntervalAt(zone: TimeZone): InstantInterval

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