//core/io.islandtime.ranges/TimePointInterval

TimePointInterval

abstract class TimePointInterval<T : TimePoint<T>> : Interval<T>

A half-open interval of time points.

Inheritors

InstantInterval
OffsetDateTimeInterval
ZonedDateTimeInterval

Properties

Name	Summary
endExclusive	common open override val endExclusive: T The end of this interval, exclusive.
endInclusive	common open override val endInclusive: T The end of this interval, inclusive.
lengthInHours	common val TimePointInterval<*>.lengthInHours: Hours The number of whole hours between the start and end of this interval.
lengthInMicroseconds	common val TimePointInterval<*>.lengthInMicroseconds: Microseconds The number of whole microseconds between the start and end of this interval.
lengthInMilliseconds	common val TimePointInterval<*>.lengthInMilliseconds: Milliseconds The number of whole milliseconds between the start and end of this interval.
lengthInMinutes	common val TimePointInterval<*>.lengthInMinutes: Minutes The number of whole minutes between the start and end of this interval.
lengthInNanoseconds	common val TimePointInterval<*>.lengthInNanoseconds: Nanoseconds The number of nanoseconds between the start and end of this interval.
lengthInSeconds	common val TimePointInterval<*>.lengthInSeconds: Seconds The number of whole seconds between the start and end of this interval.
start	common open override val start: T The start of this interval, inclusive.

Functions

Name	Summary
contains	common open operator override fun contains(value: T): Boolean Checks if this interval contains value.
contains	common fun <T> Interval<T>.contains(value: T?): Boolean Checks if this interval contains value. common operator fun <T : TimePoint<T>> TimePointInterval<T>.contains(value: TimePoint<*>?): Boolean Checks if this interval contains value. This will always return false if value is null.
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 abstract fun hasUnboundedEnd(): Boolean Checks if this interval's end is unbounded. In ISO-8601 terminology, this is an "open" end.
hasUnboundedStart	common abstract fun hasUnboundedStart(): Boolean Checks if this interval's start is unbounded. In ISO-8601 terminology, this is an "open" start.
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.
toDuration	common fun TimePointInterval<*>.toDuration(): Duration Converts this interval into a Duration of the same length.
toNSDateInterval	darwin fun <T : TimePoint<T>> TimePointInterval<T>.toNSDateInterval(): <Error class: unknown class> Converts this interval to an equivalent NSDateInterval.
toNSDateIntervalOrNull	darwin fun <T : TimePoint<T>> TimePointInterval<T>.toNSDateIntervalOrNull(): <Error class: unknown class>? Converts this interval to an equivalent NSDateInterval, or null if the interval is unbounded.