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, 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 format style for a date (year, month and day).

LocalDateLocalizer

expect class LocalDateLocalizer : DateTimeLocalizer<LocalDate>

Localizer for LocalDate.

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

Localizer for LocalDate.

actual class LocalDateLocalizer : DateTimeLocalizer<LocalDate>

Localizer for LocalDate.

LocalDateTimeLocalizer

expect class LocalDateTimeLocalizer : DateTimeLocalizer<LocalDateTime>

Localizer for LocalDateTime.

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

Localizer for LocalDateTime.

actual class LocalDateTimeLocalizer : DateTimeLocalizer<LocalDateTime>

Localizer for LocalDateTime.

LocalDateTimeOptions

data class LocalDateTimeOptions

Localization options for LocalDateTimeLocalizer and LocalDateTime.parse.

LocalTimeLocalizer

expect class LocalTimeLocalizer : DateTimeLocalizer<LocalTime>

Localizer for LocalTime.

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

Localizer for LocalTime.

actual class LocalTimeLocalizer : DateTimeLocalizer<LocalTime>

Localizer for LocalTime.

LocalTimeOptions

typealias LocalTimeOptions = TimeOptions<TimeStyleOptions.Local>

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 formatting 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 : DateTimeLocalizer<Int>

Localizer for years (Int).

actual class YearLocalizer : DateTimeLocalizer<Int>

Localizer for years (Int).

actual class YearLocalizer : DateTimeLocalizer<Int>

Localizer for years (Int).

YearMonthLocalizer

expect class YearMonthLocalizer : DateTimeLocalizer<YearMonth>

Localizer for YearMonth.

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

Localizer for YearMonth.

actual class YearMonthLocalizer : DateTimeLocalizer<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.parse.

YearOptions

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

Localization options for YearLocalizer.

ZonedInstantLocalizer

expect class ZonedInstantLocalizer : DateTimeZonedLocalizer<Instant>

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

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

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

actual class ZonedInstantLocalizer : DateTimeZonedLocalizer<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).

ZonedTimeOptions

typealias ZonedTimeOptions = TimeOptions<TimeStyleOptions.Zoned>

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 LocalDate.localize(options: DateStyleOptions, locale: PlatformLocale = getDefaultLocale()): String

Localizes this LocalDate 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.

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

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