core / io.islandtime.ranges / TimePointInterval

TimePointInterval

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) abstract class TimePointInterval<T : TimePoint<T>> : TimeInterval<T>

A half-open interval of time points.

Properties

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

endExclusive

The end of the interval, exclusive.

open val endExclusive: T
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

endInclusive

The last representable time point within the interval.

val endInclusive: T
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInDays

Get the number of 24-hour days in the interval.

open val lengthInDays: LongDays
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInHours

Get the number of whole hours in the interval.

val lengthInHours: LongHours
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInMicroseconds

Get the number of whole microseconds in the interval.

val lengthInMicroseconds: LongMicroseconds
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInMilliseconds

Get the number of whole milliseconds in the interval.

val lengthInMilliseconds: LongMilliseconds
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInMinutes

Get the number of whole minutes in the interval.

val lengthInMinutes: LongMinutes
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInNanoseconds

Get the number of whole nanoseconds in the interval.

val lengthInNanoseconds: LongNanoseconds
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

lengthInSeconds

Get the number of whole seconds in the interval.

val lengthInSeconds: LongSeconds
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

start

The start of the interval, inclusive.

open val start: T

Functions

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

asDuration

Converts this interval into a Duration of the same length.

fun asDuration(): Duration
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

contains

Check if value is within the interval based on timeline order.

open fun contains(value: T): Booleanoperator fun contains(value: TimePoint<*>): Boolean
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

equals

open fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

hashCode

open fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

isEmpty

Check if the interval is empty.

open fun isEmpty(): Boolean

Inheritors

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

InstantInterval

A half-open interval between two instants.

class InstantInterval : TimePointInterval<Instant>, TimePointProgressionBuilder<Instant>
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

OffsetDateTimeInterval

A half-open interval between two offset date-times based on timeline order.

class OffsetDateTimeInterval : TimePointInterval<OffsetDateTime>
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

ZonedDateTimeInterval

A half-open interval of zoned date-times based on timeline order.

class ZonedDateTimeInterval : TimePointInterval<ZonedDateTime>