Serializable
, Era
, TemporalAccessor
, TemporalAdjuster
public final class JapaneseEra extends Object implements Era, Serializable
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(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.
values()
method. However, there is not necessarily a 1:1 correspondence between the fields and the singleton instances., The Japanese government may announce a new era and define its start date but not its official name. In this scenario, the singleton instance that represents the new era may return a name that is not stable until the official name is defined. Developers should exercise caution when relying on the name returned by any singleton instance that does not correspond to a public static final field.Modifier and Type | Field | Description |
---|---|---|
static final JapaneseEra |
HEISEI |
The singleton instance for the 'Heisei' era (1989-01-08 - 2019-04-30) which has the value 2. |
static final JapaneseEra |
MEIJI |
The singleton instance for the 'Meiji' era (1868-01-01 - 1912-07-29) which has the value -1. |
static final JapaneseEra |
REIWA |
The singleton instance for the 'Reiwa' era (2019-05-01 - ) which has the value 3. |
static final JapaneseEra |
SHOWA |
The singleton instance for the 'Showa' era (1926-12-25 - 1989-01-07) which has the value 1. |
static final JapaneseEra |
TAISHO |
The singleton instance for the 'Taisho' era (1912-07-30 - 1926-12-24) which has the value 0. |
Modifier and Type | Method | Description |
---|---|---|
String |
getDisplayName |
Gets the textual representation of this era. |
int |
getValue() |
Gets the numeric era int value. |
static JapaneseEra |
of |
Obtains an instance of JapaneseEra from an int value. |
ValueRange |
range |
Gets the range of valid values for the specified field. |
static JapaneseEra |
valueOf |
Returns the JapaneseEra with the name. |
static JapaneseEra[] |
values() |
Returns an array of JapaneseEras. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
adjustInto, get, getLong, isSupported, query
public static final JapaneseEra MEIJI
public static final JapaneseEra TAISHO
public static final JapaneseEra SHOWA
public static final JapaneseEra HEISEI
public static final JapaneseEra REIWA
public static JapaneseEra of(int japaneseEra)
JapaneseEra
from an int
value. 1
is associated with the 'Showa' era, because it contains 1970-01-01 (ISO calendar system).-1
and 0
are associated with two earlier eras, Meiji and Taisho, respectively.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.
japaneseEra
- the era to representJapaneseEra
singleton, not nullDateTimeException
- if the value is invalidpublic static JapaneseEra valueOf(String japaneseEra)
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()
.
japaneseEra
- the japaneseEra name; non-nullJapaneseEra
singleton, never nullIllegalArgumentException
- if there is not JapaneseEra with the specified namepublic static JapaneseEra[] values()
This method may be used to iterate over the JapaneseEras as follows:
for (JapaneseEra c : JapaneseEra.values()) System.out.println(c);
public String getDisplayName(TextStyle style, Locale locale)
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.
getDisplayName
in interface Era
style
- the style of the text required, not nulllocale
- the locale to use, not nullpublic int getValue()
public ValueRange range(TemporalField 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.
range
in interface Era
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedUnsupportedTemporalTypeException
- if the unit is not supported
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/chrono/JapaneseEra.html