JapaneseEra
class JapaneseEra : Era, Serializable
kotlin.Any | |
↳ | java.time.chrono.JapaneseEra |
An era in the Japanese Imperial calendar system.
The Japanese government defines the official name and start date of each era. Eras are consecutive and their date ranges do not overlap, so the end date of one era is always the day before the start date of the next era.
The Java SE Platform supports all eras defined by the Japanese government, beginning with the Meiji era. Each era is identified in the Platform by an integer value and a name. The of(int)
and valueOf(java.lang.String)
methods may be used to obtain a singleton instance of JapaneseEra
for each era. The values()
method returns the singleton instances of all supported eras.
For convenience, this class declares a number of public static final fields that refer to singleton instances returned by the values()
method.
Summary
Public methods | |
---|---|
String! |
getDisplayName(style: TextStyle!, locale: Locale!) Gets the textual representation of this era. |
Int |
getValue() Gets the numeric era |
static JapaneseEra! |
Obtains an instance of |
ValueRange! |
range(field: TemporalField!) Gets the range of valid values for the specified field. |
String |
toString() |
static JapaneseEra! |
Returns the |
static Array<JapaneseEra!>! |
values() Returns an array of JapaneseEras. |
Inherited functions | |
---|---|
Properties | |
---|---|
static JapaneseEra! |
The singleton instance for the 'Heisei' era (1989-01-08 - 2019-04-30) which has the value 2. |
static JapaneseEra! |
The singleton instance for the 'Meiji' era (1868-01-01 - 1912-07-29) which has the value -1. |
static JapaneseEra! |
The singleton instance for the 'Reiwa' era (2019-05-01 - ) which has the value 3. |
static JapaneseEra! |
The singleton instance for the 'Showa' era (1926-12-25 - 1989-01-07) which has the value 1. |
static JapaneseEra! |
The singleton instance for the 'Taisho' era (1912-07-30 - 1926-12-24) which has the 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 SHOWA
era that contains 1970-01-01 (ISO calendar system) has the value 1. Later eras are numbered from 2 (HEISEI
). Earlier eras are numbered 0 (TAISHO
), -1 (MEIJI
)).
Return | |
---|---|
Int |
the era value |
of
static fun of(japaneseEra: Int): JapaneseEra!
Obtains an instance of JapaneseEra
from an int
value.
- The value
1
is associated with the 'Showa' era, because it contains 1970-01-01 (ISO calendar system). - The values
-1
and0
are associated with two earlier eras, Meiji and Taisho, respectively. - A value greater than
1
is associated with a later era, beginning with Heisei (2
).
Every instance of JapaneseEra
that is returned from the values()
method has an int value (available via Era#getValue()
which is accepted by this method.
Parameters | |
---|---|
japaneseEra |
Int: the era to represent |
Return | |
---|---|
JapaneseEra! |
the JapaneseEra singleton, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the value is invalid |
range
fun range(field: TemporalField!): ValueRange!
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 range of valid Japanese eras can change over time due to the nature of the Japanese calendar system.
Parameters | |
---|---|
field |
TemporalField!: the field to query the range for, not null |
Return | |
---|---|
ValueRange! |
the range of valid values for the field, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the range for the field cannot be obtained |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |
valueOf
static fun valueOf(japaneseEra: String!): JapaneseEra!
Returns the JapaneseEra
with the name.
The string must match exactly the name of the era. (Extraneous whitespace characters are not permitted.)
Valid era names are the names of eras returned from values()
.
Parameters | |
---|---|
japaneseEra |
String!: the japaneseEra name; non-null |
Return | |
---|---|
JapaneseEra! |
the JapaneseEra singleton, never null |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if there is not JapaneseEra with the specified name |
values
static fun values(): Array<JapaneseEra!>!
Returns an array of JapaneseEras. The array may contain eras defined by the Japanese government beyond the known era singletons.
This method may be used to iterate over the JapaneseEras as follows:
for (JapaneseEra c : JapaneseEra.values()) System.out.println(c);
Return | |
---|---|
Array<JapaneseEra!>! |
an array of JapaneseEras |
Properties
HEISEI
static val HEISEI: JapaneseEra!
The singleton instance for the 'Heisei' era (1989-01-08 - 2019-04-30) which has the value 2.
MEIJI
static val MEIJI: JapaneseEra!
The singleton instance for the 'Meiji' era (1868-01-01 - 1912-07-29) which has the value -1.
REIWA
static val REIWA: JapaneseEra!
The singleton instance for the 'Reiwa' era (2019-05-01 - ) which has the value 3. The end date of this era is not specified, unless the Japanese Government defines it.
SHOWA
static val SHOWA: JapaneseEra!
The singleton instance for the 'Showa' era (1926-12-25 - 1989-01-07) which has the value 1.
TAISHO
static val TAISHO: JapaneseEra!
The singleton instance for the 'Taisho' era (1912-07-30 - 1926-12-24) which has the value 0.