kdocs/dev.inmo.krontab.builder/TimeBuilder

TimeBuilder

sealed class TimeBuilder<T : Number>(source)

This class was created for incapsulation of builder work with specified restrictionsRange. For example, include function of TimeBuilder will always coerceIn incoming data using its restrictionsRange

Inheritors

Properties

first

val first: Int

The first possible value of builder

last

val last: Int

The last possible value of builder. Using of this variable equal to using "L" in strings

Functions

allowAll

fun allowAll()

After calling of this function this builder will allow any value of current time

infix fun at(value: Int)

Add one value to current timeline

each

infix inline fun each(value: Int)

Shortcut for at. In fact will

every

infix fun every(delay: Int): Array<Int>

Shortcut for "from 0 every"

every

infix fun Int.every(delay: Int): Array<Int>

Will create an sequence of times starting from every times. For example, for SecondsBuilder it will mean "from second second every 5 seconds", or "2, 7, 13, ..."

from

infix inline fun from(value: Int): Int

Just wrapper for more obvious writing something like "from 2 every 5". For example, for SecondsBuilder it will mean "from second second every 5 seconds", or "2, 7, 13, ..."

include