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

DynamicZonedYearLocalizer

class DynamicZonedYearLocalizer(options: DynamicZonedYearOptions = DynamicZonedYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeZonedLocalizer<Int> , PolyglotReferenceDateTimeLocalizer<Zoned<Int>> (source)

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

This behaves identically to DynamicYearLocalizer, but it also adds a TimeZone in the mix (only in the absolute case).

This class chooses between formatting with a RelativeYearLocalizer (if the difference is within the configured range), or falls back to absolute formatting via ZonedYearLocalizer. Note that in case of relative localization, the relative value will always be calculated using the reference's time zone and behave exactly the same as RelativeYearLocalizer.

As this class implements PolyglotReferenceValueLocalizer, it allows to use localizeAsFlow.

Because kotlinx-datetime doesn't provide a standard type for a year, there is no extension function equivalent for one-off localizations.

Examples:

last year, Los Angeles Time
1 year ago, PT
in 5y, Pacific Time
2026, Los Angeles Time
2026 AD, Pacific Time

Constructors

DynamicZonedYearLocalizer

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

Functions

localize

open override fun localize(value: Zoned<Int>, 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.

DynamicZonedYearLocalizer

See also

Constructors

Functions