ThaiBuddhistEra
class ThaiBuddhistEra : Era
Known Direct Subclasses
| ThaiBuddhistEra.BE |
The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.
|
| ThaiBuddhistEra.BEFORE_BE |
The singleton instance for the era before the current one, 'Before Buddhist Era', which has the numeric value 0.
|
|
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! |
Gets the textual representation of this era.
|
| Int |
Gets the numeric era int value.
|
| static ThaiBuddhistEra! |
Obtains an instance of ThaiBuddhistEra from an int value.
|
| Inherited functions |
From class Era
Temporal! |
adjustInto(temporal: Temporal!)
Adjusts the specified temporal object to have the same era as this object.
This returns a temporal object of the same observable type as the input with the era changed to be the same as this.
The adjustment is equivalent to using Temporal#with(TemporalField, long) passing ChronoField#ERA as the field.
In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster):
// these two lines are equivalent, but the second approach is recommended
temporal = thisEra.adjustInto(temporal);
temporal = temporal.with(thisEra);
This instance is immutable and unaffected by this method call.
|
Int |
get(field: TemporalField!)
Gets the value of the specified field from this era as an int.
This queries this era for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The ERA field returns the value of the era. All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
|
Long |
getLong(field: TemporalField!)
Gets the value of the specified field from this era as a long.
This queries this era for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The ERA field returns the value of the era. All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
|
Boolean |
isSupported(field: TemporalField!)
Checks if the specified field is supported.
This checks if this era can be queried for the specified field. If false, then calling the range and get methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The ERA field returns true. All other ChronoField instances will return false.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.
|
R |
query(query: TemporalQuery<R>!)
Queries this era using the specified query.
This queries this era using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.
The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.
|
ValueRange! |
range(field: TemporalField!)
Gets the range of valid values for the specified field.
The range object expresses the minimum and maximum valid values for a field. This era is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The ERA field returns the range. All other ChronoField instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.
The default implementation must return a range for ERA from zero to one, suitable for two era calendar systems such as ISO.
|
|
Enum values
BE
enum val BE : ThaiBuddhistEra
The singleton instance for the current era, 'Buddhist Era', which has the numeric value 1.
BEFORE_BE
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
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
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
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 |
| Exceptions |
java.time.DateTimeException |
if the era is invalid |
