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

Package-level declarations

Types

class DynamicDateAbsoluteTimeLocalizer(options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<LocalDateTime>

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

DynamicDateAbsoluteTimeOptions

data class DynamicDateAbsoluteTimeOptions(val relativeOptions: RelativeDateAbsoluteTimeOptions = RelativeDateAbsoluteTimeOptions(), val absoluteOptions: LocalDateTimeOptions = LocalDateTimeOptions(), val relativeDateDiffRange: IntRange = DynamicLocalDateOptions.DEFAULT_DIFF_RANGE) : PolyglotLocalizerOptions<DynamicDateAbsoluteTimeLocalizer>

Localization options for DynamicDateAbsoluteTimeLocalizer.

DynamicLocalDateLocalizer

class DynamicLocalDateLocalizer(options: DynamicLocalDateOptions = DynamicLocalDateOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<LocalDate>

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

DynamicLocalDateOptions

data class DynamicLocalDateOptions : PolyglotLocalizerOptions<DynamicLocalDateLocalizer>

Localization options for DynamicLocalDateLocalizer.

DynamicLocalizer

class DynamicLocalizer<T>(val thresholds: List<DynamicLocalizer.Case.Threshold<T>>, val default: DynamicLocalizer.Case.Default<T>) : PolyglotReferenceDateTimeLocalizer<T>

Special localizer class that allows to pick an arbitrary PolyglotReferenceDateTimeLocalizer based on the current reference time.

DynamicYearLocalizer

class DynamicYearLocalizer(options: DynamicYearOptions = DynamicYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeLocalizer<Int>

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

DynamicYearMonthLocalizer

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

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

DynamicYearMonthOptions

data class DynamicYearMonthOptions(val relativeOptions: RelativeYearMonthOptions = RelativeYearMonthOptions(), val absoluteOptions: YearMonthOptions = YearMonthOptions(), val relativeDiffRange: IntRange = -1..1) : PolyglotLocalizerOptions<DynamicYearMonthLocalizer>

Localization options for DynamicYearMonthLocalizer.

DynamicYearOptions

data class DynamicYearOptions(val relativeOptions: RelativeYearOptions = RelativeYearOptions(), val absoluteOptions: YearOptions = YearOptions(), val relativeDiffRange: IntRange = -1..1) : PolyglotLocalizerOptions<DynamicYearLocalizer>

Localization options for DynamicYearLocalizer.

DynamicZonedYearLocalizer

class DynamicZonedYearLocalizer(options: DynamicZonedYearOptions = DynamicZonedYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotReferenceDateTimeZonedLocalizer<Int> , PolyglotReferenceDateTimeLocalizer<Zoned<Int>>

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

DynamicZonedYearOptions

data class DynamicZonedYearOptions(val relativeOptions: RelativeZonedYearOptions = RelativeZonedYearOptions(), val absoluteOptions: ZonedYearOptions = ZonedYearOptions(), val relativeDiffRange: IntRange = -1..1) : PolyglotLocalizerOptions<DynamicZonedYearLocalizer>

Localization options for DynamicZonedYearLocalizer.

ExperimentalDynamicLocalizer

@RequiresOptIn(message = "This API is experimental. It could change or be dropped in the future without notice.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

annotation class ExperimentalDynamicLocalizer

Functions

localizeDynamic

fun LocalDate.localizeDynamic(reference: Zoned<Instant>, options: DynamicLocalDateOptions = DynamicLocalDateOptions(), locale: PlatformLocale = getDefaultLocale()): TickingValue<String>

Localizes this LocalDate dynamically (either absolute or relative to a Zoned<Instant> reference point) with the given options in the given locale.

fun YearMonth.localizeDynamic(reference: Zoned<Instant>, options: DynamicYearMonthOptions = DynamicYearMonthOptions(), locale: PlatformLocale = getDefaultLocale()): TickingValue<String>

Localizes this YearMonth dynamically (either absolute or relative to a Zoned<Instant> reference point) with the given options in the given locale.

localizeDynamicAsFlow

fun LocalDate.localizeDynamicAsFlow(options: DynamicLocalDateOptions = DynamicLocalDateOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Flow<ClockWrapper> = SYSTEM_CLOCK, timeZone: Flow<TimeZone> = SYSTEM_TIMEZONE): Flow<String>

Localizes this LocalDate dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale, returning a Flow that automatically receives new localizations as they are needed.

fun YearMonth.localizeDynamicAsFlow(options: DynamicYearMonthOptions = DynamicYearMonthOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Flow<ClockWrapper> = SYSTEM_CLOCK, timeZone: Flow<TimeZone> = SYSTEM_TIMEZONE): Flow<String>

Localizes this YearMonth dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale, returning a Flow that automatically receives new localizations as they are needed.

localizeDynamicDateAbsoluteTime

fun LocalDateTime.localizeDynamicDateAbsoluteTime(reference: Zoned<Instant>, options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale()): TickingValue<String>

Localizes this LocalDateTime dynamically (either absolute or relative to a Zoned<Instant> reference point) with the given options in the given locale.

localizeDynamicDateAbsoluteTimeAsFlow

fun LocalDateTime.localizeDynamicDateAbsoluteTimeAsFlow(options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Flow<ClockWrapper> = SYSTEM_CLOCK, timeZone: Flow<TimeZone> = SYSTEM_TIMEZONE): Flow<String>

Localizes this LocalDateTime dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale, returning a Flow that automatically receives new localizations as they are needed.

localizeDynamicDateAbsoluteTimeNow

fun LocalDateTime.localizeDynamicDateAbsoluteTimeNow(options: DynamicDateAbsoluteTimeOptions = DynamicDateAbsoluteTimeOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Clock = Clock.System, timeZone: TimeZone = TimeZone.currentSystemDefault()): TickingValue<String>

Localizes this LocalDateTime dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale.

localizeDynamicNow

fun LocalDate.localizeDynamicNow(options: DynamicLocalDateOptions = DynamicLocalDateOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Clock = Clock.System, timeZone: TimeZone = TimeZone.currentSystemDefault()): TickingValue<String>

Localizes this LocalDate dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale.

fun YearMonth.localizeDynamicNow(options: DynamicYearMonthOptions = DynamicYearMonthOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Clock = Clock.System, timeZone: TimeZone = TimeZone.currentSystemDefault()): TickingValue<String>

Localizes this YearMonth dynamically (either absolute or relative to clock @ timeZone) with the given options in the given locale.