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

Package-level declarations

Types

data class DateComponents(val eraStyle: EraStyle? = null, val yearStyle: YearStyle = YearStyle.NUMERIC_PADDED_4_DIGITS, val monthStyle: MonthStyle, val dayOfMonthStyle: DayOfMonthStyle = DayOfMonthStyle.NUMERIC, val dayOfWeekStyle: DayOfWeekStyle? = null) : DateStyleOptions, ComponentsOptions.Date.Components

Class defining the style for each component of a date (year, month and day).

DateOptions

data class DateOptions(val styleOptions: DateStyleOptions)

Simple container class for DateStyleOptions.

DateStyle

enum DateStyle : DateStyleOptions, Enum<DateStyle>

Defines a preset date style for localizing a date (year, month and day).

DateStyleOptions

sealed interface DateStyleOptions

Defines the localization style for a date (year, month and day).

DurationLocalizer

expect class DurationLocalizer : PolyglotValueLocalizer<Duration, String>

Localizer for Duration.

actual class DurationLocalizer : PolyglotValueLocalizer<ERROR CLASS: Symbol not found for Duration, String>

Localizer for Duration.

actual class DurationLocalizer : PolyglotValueLocalizer<Duration, String>

Localizer for Duration.

DurationOptions

data class DurationOptions(val minUnit: DurationUnit = DurationUnit.SECONDS, val maxUnits: Int = 2, val omitZeros: Boolean = true, val style: DurationStyle = DurationStyle.WIDE, val ifZeroLocalization: (PlatformLocale) -> String? = { null })

Localization options for DurationLocalizer and Duration.localize

ExperimentalTickingDurationLocalizer

@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 ExperimentalTickingDurationLocalizer

ExperimentalZonedLocalizer

@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 ExperimentalZonedLocalizer

LocalDateLocalizer

expect class LocalDateLocalizer : PolyglotDateTimeLocalizer<LocalDate>

Localizer for LocalDate.

actual class LocalDateLocalizer : PolyglotDateTimeLocalizer<ERROR CLASS: Symbol not found for LocalDate>

Localizer for LocalDate.

actual class LocalDateLocalizer : PolyglotDateTimeLocalizer<LocalDate>

Localizer for LocalDate.

LocalDateTimeLocalizer

expect class LocalDateTimeLocalizer : PolyglotDateTimeLocalizer<LocalDateTime>

Localizer for LocalDateTime.

actual class LocalDateTimeLocalizer : PolyglotDateTimeLocalizer<ERROR CLASS: Symbol not found for LocalDateTime>

Localizer for LocalDateTime.

actual class LocalDateTimeLocalizer : PolyglotDateTimeLocalizer<LocalDateTime>

Localizer for LocalDateTime.

LocalDateTimeOptions

data class LocalDateTimeOptions

Localization options for LocalDateTimeLocalizer and LocalDateTime.parse.

LocalTimeLocalizer

expect class LocalTimeLocalizer : PolyglotDateTimeLocalizer<LocalTime>

Localizer for LocalTime.

actual class LocalTimeLocalizer : PolyglotDateTimeLocalizer<ERROR CLASS: Symbol not found for LocalTime>

Localizer for LocalTime.

actual class LocalTimeLocalizer : PolyglotDateTimeLocalizer<LocalTime>

Localizer for LocalTime.

LocalTimeOptions

typealias LocalTimeOptions = TimeOptions<TimeStyleOptions.Local>

TickingDurationLocalizer

class TickingDurationLocalizer(options: TickingDurationOptions = TickingDurationOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotValueLocalizer<Duration, TickingValue<String>> , PolyglotReferenceValueLocalizer<Instant>

Localizes a Duration in the same exact way as a DurationLocalizer, but this is meant to be used to localize duration values that change over time (e.g. a countdown). For static durations use DurationLocalizer instead.

TickingDurationOptions

data class TickingDurationOptions(val durationOptions: DurationOptions = DurationOptions(), val abs: Boolean = false)

Localization options for TickingDurationLocalizer and Duration.localizeTicking.

TimeComponents

sealed interface TimeComponents : TimeStyleOptions

Interface defining the style for each component of a time.

TimeOptions

data class TimeOptions<out SO : TimeStyleOptions>(val styleOptions: SO, val hourCycle: HourCycle? = null)

Options to pass when localizing time.

TimeStyle

sealed interface TimeStyle : TimeStyleOptions

Defines a preset time style for localizing a time.

TimeStyleOptions

sealed interface TimeStyleOptions

Options to pass to TimeOptions.styleOptions, that define the style of each time component.

YearLocalizer

expect class YearLocalizer : PolyglotDateTimeLocalizer<Int>

Localizer for years (Int).

actual class YearLocalizer : PolyglotDateTimeLocalizer<Int>

Localizer for years (Int).

actual class YearLocalizer : PolyglotDateTimeLocalizer<Int>

Localizer for years (Int).

YearMonthLocalizer

expect class YearMonthLocalizer : PolyglotDateTimeLocalizer<YearMonth>

Localizer for YearMonth.

actual class YearMonthLocalizer : PolyglotDateTimeLocalizer<ERROR CLASS: Symbol not found for YearMonth>

Localizer for YearMonth.

actual class YearMonthLocalizer : PolyglotDateTimeLocalizer<YearMonth>

Localizer for YearMonth.

YearMonthOptions

data class YearMonthOptions(val eraStyle: EraStyle? = null, val yearStyle: YearStyle = YearStyle.NUMERIC, val monthStyle: MonthStyle?) : ComponentsOptions.Date.Components

Localization options for YearMonthLocalizer and YearMonth.localize.

YearOptions

data class YearOptions(val eraStyle: EraStyle? = null, val yearStyle: YearStyle = YearStyle.NUMERIC) : ComponentsOptions.Date.Components

Localization options for YearLocalizer.

ZonedDateOptions

data class ZonedDateOptions

Localization options for ZonedLocalDateLocalizer.

ZonedInstantLocalizer

expect class ZonedInstantLocalizer : PolyglotDateTimeZonedLocalizer<Instant>

Localizer for an Instant paired with a TimeZone (see Zoned).

actual class ZonedInstantLocalizer : PolyglotDateTimeZonedLocalizer<ERROR CLASS: Symbol not found for Instant>

Localizer for an Instant paired with a TimeZone (see Zoned).

actual class ZonedInstantLocalizer : PolyglotDateTimeZonedLocalizer<Instant>

Localizer for an Instant paired with a TimeZone (see Zoned).

ZonedInstantOptions

data class ZonedInstantOptions

Localization options for ZonedInstantLocalizer and Zoned.localize (where Zoned is of type Instant).

ZonedLocalDateLocalizer

class ZonedLocalDateLocalizer(options: ZonedDateOptions, locale: PlatformLocale = getDefaultLocale()) : PolyglotDateTimeZonedLocalizer<LocalDate>

Localizer for Zoned<LocalDate>.

ZonedTimeOptions

typealias ZonedTimeOptions = TimeOptions<TimeStyleOptions.Zoned>

ZonedYearLocalizer

class ZonedYearLocalizer(options: ZonedYearOptions = ZonedYearOptions(), locale: PlatformLocale = getDefaultLocale()) : PolyglotDateTimeZonedLocalizer<Int>

Localizer for Zoned years (Zoned<Int>).

ZonedYearMonthLocalizer

class ZonedYearMonthLocalizer(options: ZonedYearMonthOptions, locale: PlatformLocale = getDefaultLocale()) : PolyglotDateTimeZonedLocalizer<YearMonth>

Localizer for Zoned<YearMonth>.

ZonedYearMonthOptions

data class ZonedYearMonthOptions(val yearMonthOptions: YearMonthOptions, val timeZoneOptions: TimeZoneOptions = TimeZoneOptions())

Localization options for ZonedYearMonthLocalizer.

ZonedYearOptions

data class ZonedYearOptions(val yearOptions: YearOptions = YearOptions(), val timeZoneOptions: TimeZoneOptions = TimeZoneOptions())

Localization options for ZonedYearLocalizer.

Functions

invoke

operator fun LocalDateTimeOptions.Companion.invoke(dateOptions: DateStyleOptions, timeOptions: LocalTimeOptions): LocalDateTimeOptions

operator fun LocalDateTimeOptions.Companion.invoke(dateOptions: DateStyleOptions, timeOptions: TimeStyleOptions.Local): LocalDateTimeOptions

operator fun ZonedInstantOptions.Companion.invoke(dateOptions: DateStyleOptions, timeOptions: ZonedTimeOptions): ZonedInstantOptions

operator fun ZonedInstantOptions.Companion.invoke(dateOptions: DateStyleOptions, timeOptions: TimeStyleOptions.Zoned): ZonedInstantOptions

Allows creation of mixed style and components between date and time, which is not possible in all platforms

localize

fun Zoned<Instant>.localize(options: ZonedInstantOptions, locale: PlatformLocale = getDefaultLocale()): String

Localizes this Instant at this TimeZone with the given options in the given locale.

fun Zoned<LocalDate>.localize(options: ZonedDateOptions, locale: PlatformLocale = getDefaultLocale()): String

fun LocalDate.localize(options: DateStyleOptions, locale: PlatformLocale = getDefaultLocale()): String

Localizes this LocalDate with the given options in the given locale.

fun Zoned<YearMonth>.localize(options: ZonedYearMonthOptions, locale: PlatformLocale = getDefaultLocale()): String

fun YearMonth.localize(options: YearMonthOptions, locale: PlatformLocale = getDefaultLocale()): String

Localizes this YearMonth with the given options in the given locale.

fun Duration.localize(options: DurationOptions = DurationOptions(), locale: PlatformLocale = getDefaultLocale()): String

Localizes this Duration with the given options in the given locale.

fun LocalDateTime.localize(options: LocalDateTimeOptions, locale: PlatformLocale = getDefaultLocale()): String

Localizes this LocalDateTime with the given options in the given locale.

fun LocalTime.localize(options: LocalTimeOptions, locale: PlatformLocale = getDefaultLocale()): String

fun LocalTime.localize(options: TimeStyleOptions.Local, locale: PlatformLocale = getDefaultLocale()): String

Localizes this LocalTime with the given options in the given locale.

localizeDiff

fun Instant.localizeDiff(options: TickingDurationOptions = TickingDurationOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Clock = Clock.System): TickingValue<String>

Calculates the diff between this Instant and the current instnat of clock, and localizes the result with the given options in the given locale.

fun Instant.localizeDiff(reference: Instant, options: TickingDurationOptions = TickingDurationOptions(), locale: PlatformLocale = getDefaultLocale()): TickingValue<String>

Calculates the diff between this Instant and reference, and localizes the result with the given options in the given locale.

localizeDiffAsFlow

fun Instant.localizeDiffAsFlow(options: TickingDurationOptions = TickingDurationOptions(), locale: PlatformLocale = getDefaultLocale(), clock: Clock = Clock.System): Flow<String>

Calculates the diff between this Instant and clock, and localizes the result with the given options in the given locale, returning a Flow that automatically receives new localizations as they are needed.

localizeTicking

fun Duration.localizeTicking(options: TickingDurationOptions = TickingDurationOptions(), locale: PlatformLocale = getDefaultLocale()): TickingValue<String>

Localizes this Duration with the given options in the given locale same as Duration.localize, but returns a TickingValue instead.