//core/io.islandtime.ranges/InstantInterval

InstantInterval

A half-open interval between two instants.

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

class InstantInterval(start: Instant,endExclusive: Instant) : TimePointInterval<Instant> , TimePointProgressionBuilder<Instant>

Constructors

InstantInterval

common

fun InstantInterval(start: Instant, endExclusive: Instant)

Types

Companion

common

object Companion

Functions

asDuration

common

Converts this interval into a Duration of the same length.

override fun asDuration(): Duration

contains

common

Checks if this interval contains value.

open operator override fun contains(value: Instant): 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

Properties

endExclusive

common

The end of this interval, exclusive.

open override val endExclusive: Instant

endInclusive

common

The end of this interval, inclusive.

open override val endInclusive: Instant

first

common

open override val first: Instant

last

common

open override val last: Instant

lengthInDays

common

The number of 24-hour days in this interval.

open override val lengthInDays: LongDays

lengthInHours

common

The number of whole hours in this interval.

override val lengthInHours: LongHours

lengthInMicroseconds

common

The number of whole microseconds in this interval.

override val lengthInMicroseconds: LongMicroseconds

lengthInMilliseconds

common

The number of whole milliseconds in this interval.

override val lengthInMilliseconds: LongMilliseconds

lengthInMinutes

common

The number of whole minutes in this interval.

override val lengthInMinutes: LongMinutes

lengthInNanoseconds

common

The number of whole nanoseconds in this interval.

override val lengthInNanoseconds: LongNanoseconds

lengthInSeconds

common

The number of whole seconds in this interval.

override val lengthInSeconds: LongSeconds

start

common

The start of this interval, inclusive.

open override val start: Instant

Extensions

common

Combines this InstantInterval with a TimeZone to create an equivalent ZonedDateTimeInterval where both endpoints are in zone.

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

random

common

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

fun InstantInterval.random(): Instant

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

fun InstantInterval.random(random: Random): Instant

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 InstantInterval.randomOrNull(): Instant?

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

fun InstantInterval.randomOrNull(random: Random): Instant?

toDateRangeAt

common

Converts this interval to the equivalent DateRange when both endpoints are in zone.

fun InstantInterval.toDateRangeAt(zone: TimeZone): DateRange

toDateTimeIntervalAt

common

Converts this interval to the equivalent DateTimeInterval when both endpoints are in zone.

fun InstantInterval.toDateTimeIntervalAt(zone: TimeZone): DateTimeInterval