Added in API level 26

ThaiBuddhistEra

class ThaiBuddhistEra : Era
kotlin.Any
   ↳ kotlin.Enum<java.time.chrono.ThaiBuddhistEra>
   ↳ java.time.chrono.ThaiBuddhistEra

An era in the Thai Buddhist calendar system.

The Thai Buddhist calendar system has two eras. The current era, for years from 1 onwards, is known as the 'Buddhist' era. All previous years, zero or earlier in the proleptic count or one and greater in the year-of-era count, are part of the 'Before Buddhist' era.

Buddhist years and eras
year-of-era era proleptic-year ISO proleptic-year
2 BE 2 -542
1 BE 1 -543
1 BEFORE_BE 0 -544
2 BEFORE_BE -1 -545

Do not use ordinal() to obtain the numeric representation of ThaiBuddhistEra. Use getValue() instead.

Summary

Enum values

The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.

The singleton instance for the era before the current one, 'Before Buddhist Era', which has the numeric value 0.

Public methods
String!
getDisplayName(style: TextStyle!, locale: Locale!)

Gets the textual representation of this era.

Int

Gets the numeric era int value.

static ThaiBuddhistEra!
of(thaiBuddhistEra: Int)

Obtains an instance of ThaiBuddhistEra from an int value.

Inherited functions

Enum values

BE

Added in API level 26
enum val BE : ThaiBuddhistEra

The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.

BEFORE_BE

Added in API level 26
enum val BEFORE_BE : ThaiBuddhistEra

The singleton instance for the era before the current one, 'Before Buddhist Era', which has the numeric value 0.

Public methods

getDisplayName

Added in API level 26
fun getDisplayName(
    style: TextStyle!,
    locale: Locale!
): String!

Gets the textual representation of this era.

This returns the textual name used to identify the era, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters
style TextStyle!: the style of the text required, not null
locale Locale!: the locale to use, not null
Return
String! the text value of the era, not null

getValue

Added in API level 26
fun getValue(): Int

Gets the numeric era int value.

The era BEFORE_BE has the value 0, while the era BE has the value 1.

Return
Int the era value, from 0 (BEFORE_BE) to 1 (BE)

of

Added in API level 26
static fun of(thaiBuddhistEra: Int): ThaiBuddhistEra!

Obtains an instance of ThaiBuddhistEra from an int value.

ThaiBuddhistEra is an enum representing the Thai Buddhist eras of BEFORE_BE/BE. This factory allows the enum to be obtained from the int value.

Parameters
thaiBuddhistEra Int: the era to represent, from 0 to 1
Return
ThaiBuddhistEra! the BuddhistEra singleton, never null
Exceptions
java.time.DateTimeException if the era is invalid