Added in API level 26

IsoEra

class IsoEra : Era

kotlin.Any
↳	kotlin.Enum<java.time.chrono.IsoEra>
	↳	java.time.chrono.IsoEra

Known Direct Subclasses IsoEra.BCE, IsoEra.CE IsoEra.BCE The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0. IsoEra.CE The singleton instance for the current era, 'Current Era', which has the numeric value 1.

An era in the ISO calendar system.

The ISO-8601 standard does not define eras. A definition has therefore been created with two eras - 'Current era' (CE) for years on or after 0001-01-01 (ISO), and 'Before current era' (BCE) for years before that.

ISO years and eras

year-of-era	era	proleptic-year
2	CE	2
1	CE	1
1	BCE	0
2	BCE	-1

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

Summary

Enum values
BCE The singleton instance for the era before the current one, 'Before Current Era', which has the numeric value 0.
CE The singleton instance for the current era, 'Current Era', which has the numeric value 1.

Public methods
Int	getValue() Gets the numeric era int value.
static IsoEra!	of(isoEra: Int) Obtains an instance of IsoEra 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. String! getDisplayName(style: TextStyle!, locale: Locale!) 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. 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

BCE

Added in API level 26

enum val BCE : IsoEra

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

CE

Added in API level 26

enum val CE : IsoEra

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

Public methods

getValue

Added in API level 26

fun getValue(): Int

Gets the numeric era int value.

The era BCE has the value 0, while the era CE has the value 1.

Return
Int	the era value, from 0 (BCE) to 1 (CE)

of

Added in API level 26

static fun of(isoEra: Int): IsoEra!

Obtains an instance of IsoEra from an int value.

IsoEra is an enum representing the ISO eras of BCE/CE. This factory allows the enum to be obtained from the int value.

Parameters
isoEra	Int: the BCE/CE value to represent, from 0 (BCE) to 1 (CE)

Return
IsoEra!	the era singleton, not null

Exceptions
java.time.DateTimeException	if the value is invalid