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

RelativeDateAbsoluteTimeLocalizer

class RelativeDateAbsoluteTimeLocalizer(options: RelativeDateAbsoluteTimeOptions = RelativeDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<LocalDateTime> (source)

Localizes the date part of a LocalDateTime relative to a Zoned<Instant> reference point, and the time part absolutely.

This is mostly glue between RelativeLocalDateLocalizer and LocalTimeLocalizer. See their documentation to understand RelativeDateAbsoluteTimeOptions.dateOptions and RelativeDateAbsoluteTimeOptions.timeOptions.

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

Examples:

yesterday at 9:00 PM
next Sunday at 4:00 AM
in 15 days, 3:00 AM
21 days ago at 7:00 PM

Constructors

RelativeDateAbsoluteTimeLocalizer

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

Functions

localize

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