core / io.islandtime.format / DateTimeTextProvider

DateTimeTextProvider

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) interface DateTimeTextProvider

An abstraction that allows localized date-time text to be supplied from different data sources.

Types

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

Companion

companion object Companion : DateTimeTextProvider

Functions

amPmTextFor

Get the localized AM/PM text.

(jvm) open fun amPmTextFor(value: Long, locale: Locale): String?
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun amPmTextFor(value: Long, locale: <ERROR CLASS>): String?

dayOfWeekTextFor

Get the localized day of the week text for a given ISO day of week number.

(jvm) open fun dayOfWeekTextFor(value: Long, style: TextStyle, locale: Locale): String?
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun dayOfWeekTextFor(value: Long, style: TextStyle, locale: <ERROR CLASS>): String?

eraTextFor

Get the localized ISO era text.

(jvm) open fun eraTextFor(value: Long, style: TextStyle, locale: Locale): String?
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun eraTextFor(value: Long, style: TextStyle, locale: <ERROR CLASS>): String?

monthTextFor

Get the localized month text for a given ISO month number.

(jvm) open fun monthTextFor(value: Long, style: TextStyle, locale: Locale): String?
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun monthTextFor(value: Long, style: TextStyle, locale: <ERROR CLASS>): String?

parsableTextFor

Get a list of all localized text in a particular style along with the values associated that text. The list will be sorted in descending order by the length of text, making it suitable for parsing.

(jvm) open fun parsableTextFor(field: DateTimeField, style: TextStyle, locale: Locale): ParsableTextList
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun parsableTextFor(field: DateTimeField, style: TextStyle, locale: <ERROR CLASS>): ParsableTextList

Get a list of all localized text in a set of styles along with the values associated that text. The list will be sorted in descending order by the length of text, making it suitable for parsing.

(jvm) abstract fun parsableTextFor(field: DateTimeField, styles: Set<TextStyle>, locale: Locale): ParsableTextList
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) abstract fun parsableTextFor(field: DateTimeField, styles: Set<TextStyle>, locale: <ERROR CLASS>): ParsableTextList

textFor

Get localized text for the specified field, value, style, and locale.

(jvm) open fun textFor(field: DateTimeField, value: Long, style: TextStyle, locale: Locale): String?
(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) open fun textFor(field: DateTimeField, value: Long, style: TextStyle, locale: <ERROR CLASS>): String?

Inheritors

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

Companion

companion object Companion : DateTimeTextProvider
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

PlatformDateTimeTextProvider

The default provider of localized date-time text for the current platform.

object PlatformDateTimeTextProvider : DateTimeTextProvider