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

RelativeZonedYearLocalizer

class RelativeZonedYearLocalizer(options: RelativeZonedYearOptions = RelativeZonedYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeZonedLocalizer<Int> (source)

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

This behaves identically to RelativeYearLocalizer, but it also adds a TimeZone in the mix. Note that the localized value is always relative to the reference time zone: the value's time zone is simply added in output, but it does not affect relative calculations.

Because a year represents a big span of time, the timezone could have different offsets at different moments within the year. For this reason, only the TimeZoneStyle.Generic subset is allowed in the options for the time zone style.

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 yr., Los Angeles Time
this year, PT
1 year ago, Pacific Time
in 5y, America/Los_Angeles

Constructors

RelativeZonedYearLocalizer

constructor(options: RelativeZonedYearOptions = RelativeZonedYearOptions(), 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.

RelativeZonedYearLocalizer

See also

Constructors

Functions