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

DynamicYearMonthLocalizer

class DynamicYearMonthLocalizer(options: DynamicYearMonthOptions, locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceValueLocalizer<YearMonth> (source)

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

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

Create once and re-use for localizing multiple values with the same options. Use YearMonth.localizeDynamic or YearMonth.localizeDynamicAsFlow for one-off localizations.

Examples:

last month
1 month ago
in 5 mo
07/2026
July 2026

Constructors

DynamicYearMonthLocalizer

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

Functions

localize

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

DynamicYearMonthLocalizer

See also

Constructors

Functions