datetime-polyglot/dev.mmauro.datetimepolyglot.localizers.relative/RelativeYearLocalizer

RelativeYearLocalizer

class RelativeYearLocalizer(options: RelativeYearOptions = RelativeYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceValueLocalizer<Int> (source)

Localizes a year relative to a Zoned<Instant> reference point.

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

Localization could, based on options, prioritize a word style localization (e.g. last year) over a numeric style (e.g. 1 year ago).

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

Examples:

last yr.
this year
next year
1 year ago
in 5y

Constructors

RelativeYearLocalizer

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

Functions

localize

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

localizeDiff

fun localizeDiff(diff: Int): String

Convenience function to format an already calculated diff of years (e.g. -1 for last year).

RelativeYearLocalizer

See also

Constructors

Functions