Skip to content

//core/io.islandtime.format/DateTimeTextProvider

DateTimeTextProvider

interface DateTimeTextProvider

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

Inheritors

Companion
PlatformDateTimeTextProvider

Types

Name Summary
Companion

common


object Companion : DateTimeTextProvider

Functions

Name Summary
amPmTextFor

common


open fun amPmTextFor(value: Long, locale: Locale): String?

Get the localized AM/PM text.
dayOfWeekTextFor

common


open fun dayOfWeekTextFor(value: Long, style: TextStyle, locale: Locale): String?

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

common


open fun eraTextFor(value: Long, style: TextStyle, locale: Locale): String?

Get the localized ISO era text.
monthTextFor

common


open fun monthTextFor(value: Long, style: TextStyle, locale: Locale): String?

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

common


open fun parsableTextFor(field: DateTimeField, style: TextStyle, locale: Locale): ParsableTextList

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.

common


abstract fun parsableTextFor(field: DateTimeField, styles: Set<TextStyle>, locale: Locale): 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.
textFor

common


open fun textFor(field: DateTimeField, value: Long, style: TextStyle, locale: Locale): String?

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