//core/io.islandtime.format/DateTimeTextProvider

DateTimeTextProvider

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

interface DateTimeTextProvider

Types

Companion

common

object Companion : DateTimeTextProvider

Functions

amPmTextFor

common

Get the localized AM/PM text.

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

dayOfWeekTextFor

common

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

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

equals

common

open operator override fun equals(other: Any?): Boolean

eraTextFor

common

Get the localized ISO era text.

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

hashCode

common

open override fun hashCode(): Int

monthTextFor

common

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

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

parsableTextFor

common

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.

Any text with conflicting values will be excluded. For example, the English narrow month name "M" could be March or May, so any attempt to parse it would be ambiguous.

open fun parsableTextFor(field: DateTimeField, style: TextStyle, locale: Locale): List<Pair<String, Long>>

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.

Any text with conflicting values will be excluded. For example, the English narrow month name "M" could be March or May, so any attempt to parse it would be ambiguous.

abstract fun parsableTextFor(field: DateTimeField, styles: Set<TextStyle>, locale: Locale): List<Pair<String, Long>>

textFor

common

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

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

toString

common

open override fun toString(): String

Inheritors

DateTimeTextProvider

common

PlatformDateTimeTextProvider