korge-foundation/korlibs.time/DateTimeRange

DateTimeRange

data class DateTimeRange(val from: DateTime, val to: DateTime) : Comparable<DateTime> , Serializable

Represents a right-opened range between two dates.

Constructors

DateTimeRange

constructor(from: DateTime, to: DateTime)

Types

Companion

object Companion

Properties

duration

val duration: TimeSpan

Duration TimeSpan without having into account actual months/years.

val from: DateTime

val max: DateTime

val min: DateTime

val size: TimeSpan

val span: DateTimeSpan

DateTimeSpan distance between two dates, month and year aware.

val to: DateTime

valid

val valid: Boolean

Functions

compareTo

open operator override fun compareTo(other: DateTime): Int

contains

operator fun contains(date: DateTime): Boolean

Checks if a date is contained in this range.

operator fun contains(other: DateTimeRange): Boolean

intersectionWith

fun intersectionWith(that: DateTimeRange, rightOpen: Boolean = true): DateTimeRange?

Returns new DateTimeRange or null - the result of intersection of this and that DateTimeRanges.

intersectsOrInContactWith

fun intersectsOrInContactWith(that: DateTimeRange): Boolean

Returns true if this and that DateTimeRanges have intersection or at least a common end otherwise false.

intersectsWith

fun intersectsWith(that: DateTimeRange, rightOpen: Boolean = true): Boolean

Returns true if this and that DateTimeRanges have intersection otherwise false.

mergeOnContactOrNull

fun mergeOnContactOrNull(that: DateTimeRange): DateTimeRange?

Returns new DateTimeRange or null - the result of merging this and that DateTimeRanges if they have intersection.

toString

open override fun toString(): String

fun toString(format: DateFormat): String

toStringDefault

fun toStringDefault(): String

toStringLongs

fun toStringLongs(): String

without

fun without(that: DateTimeRange): List<DateTimeRange>

Returns a List of 0, 1 or 2 DateTimeRanges - the result of removing that DateTimeRange from this one