datetime-polyglot/dev.mmauro.datetimepolyglot.localizers.dynamic/DynamicDateAbsoluteTimeLocalizer

DynamicDateAbsoluteTimeLocalizer

class DynamicDateAbsoluteTimeLocalizer(options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<LocalDateTime> (source)

Localizes a LocalDateTime dynamically (either absolute or relative to a Zoned<Instant> reference point).

This class chooses between formatting with a RelativeDateAbsoluteTimeLocalizer (if the difference is within the configured range), or falls back to absolute formatting via LocalDateLocalizer.

So, in essence, the time is always localized absolutely, while the date is dynamic.

Create once and re-use for localizing multiple values with the same options. Use LocalDateTime.localizeDynamicDateAbsoluteTime or LocalDateTime.localizeDynamicDateAbsoluteTimeAsFlow for one-off localizations.

Examples:

yesterday at 9:00 AM
1 day ago at 18:00
next Sunday at 12:00 PM
January 1 2026 at 8 in the morning
1/1/26, 8 PM

Constructors

DynamicDateAbsoluteTimeLocalizer

constructor(options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale())

Functions

localize

open override fun localize(value: LocalDateTime, reference: Zoned<Instant>): TickingValue<String>

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.

DynamicDateAbsoluteTimeLocalizer

See also

Constructors

Functions