core/dev.mmauro.datetimepolyglot.localizers/PolyglotReferenceValueLocalizer

PolyglotReferenceValueLocalizer

interface PolyglotReferenceValueLocalizer<in T, out R> : PolyglotLocalizer

A generic PolyglotLocalizer that accepts a value of type T and a Zoned<Instant> reference point, and returns a TickingValue of type R.

The TickingValue.nextTick represent the amount of time that the reference needs to advance by for the TickingValue.value to change, thus requiring a new call to localize with the same exact value but updated reference, assuming that the time moves forward linearly.

If you are using coroutines, a convenience localizeAsFlow is also provided.

Note that any class implementing this interface is not strictly required to return the same exact string for the same value in different platforms.

Inheritors

PolyglotReferenceDateTimeLocalizer

Functions

localize

abstract fun localize(value: T, reference: Zoned<Instant>): TickingValue<R>

localizeAsFlow

fun <T, R> PolyglotReferenceValueLocalizer<T, R>.localizeAsFlow(value: T, clock: Flow<ClockWrapper> = SYSTEM_CLOCK, timeZone: Flow<TimeZone> = SYSTEM_TIMEZONE, maxTick: Duration? = null): Flow<R>

Localizes value by using the given clock's Clock.now and timeZone flows as a reference point and returns a Flow that emits updated values based on the underlying TickingValue.nextTick. This function assumes that each Clock emitted by the clock flow moves forward linearly.

localizeNow

fun <T, R> PolyglotReferenceValueLocalizer<T, R>.localizeNow(value: T, clock: Clock = Clock.System, timeZone: TimeZone = TimeZone.currentSystemDefault()): TickingValue<R>

Localizes value by using the given clock's Clock.now and timeZone as a reference point, rather than passing the reference explicitly.

map

fun <T, R1, R2> PolyglotReferenceValueLocalizer<T, R1>.map(map: (value: T, localized: TickingValue<R1>, reference: Zoned<Instant>) -> TickingValue<R2>): PolyglotReferenceValueLocalizer<T, R2>

Returns a new PolyglotReferenceValueLocalizer that localizes the received value using this localizer, calls map, and returns whatever TickingValue the mapping function returns.

toTickingValueProvider

fun <T, R> PolyglotReferenceValueLocalizer<T, R>.toTickingValueProvider(value: T): TickingValueProvider<R>

Fixes the value to localize and returns a TickingValueProvider using this PolyglotReferenceValueLocalizer as source for TickingValues.