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

RelativeYearMonthLocalizer

class RelativeYearMonthLocalizer(options: RelativeYearMonthOptions = RelativeYearMonthOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<YearMonth> (source)

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

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

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

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

Examples:

this month
last mo.
next month
4 months ago
in 34mo.

Constructors

RelativeYearMonthLocalizer

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

Functions

localize

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

localizeDiff

fun localizeDiff(diff: Int): String

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

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.

RelativeYearMonthLocalizer

See also

Constructors

Functions