Verdandi/com.github.abraga.verdandi.api.model.recurrence/VerdandiRecurrenceMoments

VerdandiRecurrenceMoments

@Serializable

data class VerdandiRecurrenceMoments : List<VerdandiMoment>

Represents the result of a recurrence rule evaluation: a finite, ordered collection of VerdandiMoment instances generated according to a frequency, interval, and optional day-of-week or time-of-day constraints.

This class implements List<VerdandiMoment> via delegation, so it can be used directly in any context that expects a list of moments (iteration, indexing, etc.).

Instances are created exclusively through Verdandi.recurrence:

val fridays: VerdandiRecurrenceMoments = Verdandi.recurrence {
    every week on fridays indefinitely
}

val dailyAt9: VerdandiRecurrenceMoments = Verdandi.recurrence(start) {
    every day at { 9.hours } until end
}

Properties

val endMoment: VerdandiMoment

The moment at or before which the last occurrence falls. For indefinite recurrences this equals the last generated occurrence.

open override val size: Int

val startMoment: VerdandiMoment

The anchor moment from which the recurrence begins.

Functions

open operator override fun contains(element: VerdandiMoment): Boolean

open override fun containsAll(elements: Collection<VerdandiMoment>): Boolean

fun exclude(vararg moments: VerdandiMoment): VerdandiRecurrenceMoments

Returns a new VerdandiRecurrenceMoments instance with the specified moments excluded.

infix fun filter(predicate: (VerdandiMoment) -> Boolean): VerdandiRecurrenceMoments

Filters the recurrence moments based on the provided predicate.

infix fun format(block: VerdandiFormatScope.() -> VerdandiFormatPattern): List<String>

Formats each moment in the recurrence according to the provided block pattern.

open operator override fun get(index: Int): VerdandiMoment

open override fun indexOf(element: VerdandiMoment): Int

open override fun isEmpty(): Boolean

open operator override fun iterator(): Iterator<VerdandiMoment>

open override fun lastIndexOf(element: VerdandiMoment): Int

open override fun listIterator(): ListIterator<VerdandiMoment>

open override fun listIterator(index: Int): ListIterator<VerdandiMoment>

fun matches(moment: VerdandiMoment): Boolean

Checks if the given moment matches the recurrence rule and is not excluded.

open override fun subList(fromIndex: Int, toIndex: Int): List<VerdandiMoment>

fun toInterval(): VerdandiInterval?

Converts the first and last moments of the recurrence to a VerdandiInterval.

open override fun toString(): String