core / io.islandtime.format / PlatformDateTimeTextProvider / monthTextFor

monthTextFor

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

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

Parameters

value - an ISO month number, from January (1) to December (12)

style - the style of the text

locale - the locale

Exceptions

DateTimeException - if the value is not a valid month number

Return
the localized month text or null if unavailable

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

Overrides DateTimeTextProvider.monthTextFor

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

Parameters

value - an ISO month number, from January (1) to December (12)

style - the style of the text

locale - the locale

Exceptions

DateTimeException - if the value is not a valid month number

Return
the localized month text or null if unavailable