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

DynamicZonedYearLocalizer

class DynamicZonedYearLocalizer(options: DynamicZonedYearOptions = DynamicZonedYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceValueLocalizer<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
1 year ago
in 5y
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>

localize

fun <T> PolyglotReferenceValueLocalizer<T>.localize(value: T, clock: Clock = Clock.System): TickingValue<String>

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

localizeAsFlow

fun <T> PolyglotReferenceValueLocalizer<T>.localizeAsFlow(value: T, clock: Clock = Clock.System, maxTick: Duration? = null): Flow<String>

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

DynamicZonedYearLocalizer

See also

Constructors

Functions