Verdandi/com.github.abraga.verdandi.api.model/VerdandiInterval

VerdandiInterval

@Serializable

data class VerdandiInterval : VerdandiFromMomentFactoryScope, VerdandiIntervalOperationScope

A half-open time interval [start, end) between two VerdandiMoment instances.

Intervals are always normalized so that start ≤ end. They can be created through the com.github.abraga.verdandi.Verdandi entry point:

val recent = Verdandi.interval { last thirty days }
val custom = Verdandi.interval("2025-01-01T00:00:00Z", "2025-12-31T23:59:59Z")
val range = Verdandi.interval(startMs..endMs)

Operations

Intervals expose set-like operations and duration computation through VerdandiIntervalOperationScope:

interval.contains(moment)
interval.overlaps(other)
interval.intersection(other)
interval.union(other)
interval.duration()  // DateTimeDuration

Adjustments

The adjust DSL allows shifting, expanding, shrinking, and aligning interval bounds:

val adjusted = interval adjust {
    shiftBoth(2.hours)
    alignToFullDays()
}

Factory access

An interval also implements VerdandiFromMomentFactoryScope, allowing creation of moments relative to it:

val midpoint = interval.at(
    year = 2025, month = 6, day = 15
)

Types

Companion

object Companion

Properties

end

val end: VerdandiMoment

the exclusive upper bound of the interval.

start

val start: VerdandiMoment

the inclusive lower bound of the interval.

Functions

adjust

infix fun adjust(block: VerdandiIntervalAdjustScope.(VerdandiInterval) -> Unit): VerdandiInterval

Adjusts this interval using the interval-specific DSL.

contains

open override fun contains(other: VerdandiMoment): Boolean

duration

open override fun duration(): DateTimeDuration

expand

open override fun expand(duration: Duration): VerdandiInterval

from

open infix override fun from(moment: VerdandiMoment): VerdandiInterval

intersection

open override fun intersection(other: VerdandiInterval): VerdandiInterval?

isEmpty

open override fun isEmpty(): Boolean

minus

open operator override fun minus(duration: Duration): VerdandiInterval

overlaps

open override fun overlaps(other: VerdandiInterval): Boolean

plus

open operator override fun plus(duration: Duration): VerdandiInterval

shrink

open override fun shrink(duration: Duration): VerdandiInterval

toString

open override fun toString(): String

union

open override fun union(other: VerdandiInterval): VerdandiInterval?