public enum IsoEra extends Enum<IsoEra> implements Era
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.
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.
This is an immutable and thread-safe enum.
Enum Constant and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have the same era as this object.
|
int |
get(TemporalField field)
Gets the value of the specified field from this era as an
int . |
long |
getLong(TemporalField field)
Gets the value of the specified field from this era as a
long . |
int |
getValue()
Gets the numeric era
int value. |
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
static IsoEra |
of(int isoEra)
Obtains an instance of
IsoEra from an int value. |
<R> R |
query(TemporalQuery<R> query)
Queries this era using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
static IsoEra |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static IsoEra[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final IsoEra BCE
public static final IsoEra CE
public Temporal adjustInto(Temporal temporal)
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.
adjustInto
in interface Era
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentpublic int get(TemporalField field)
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.
get
in interface Era
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtained or
the value is outside the range of valid values for the fieldUnsupportedTemporalTypeException
- if the field is not supported or
the range of values exceeds an int
public long getLong(TemporalField field)
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.
getLong
in interface Era
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedpublic int getValue()
int
value.
The era BCE has the value 0, while the era CE has the value 1.
public boolean isSupported(@Nullable TemporalField field)
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.
isSupported
in interface Era
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic static IsoEra of(int isoEra)
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.
isoEra
- the BCE/CE value to represent, from 0 (BCE) to 1 (CE)DateTimeException
- if the value is invalid@Nullable public <R> R query(TemporalQuery<R> 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.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)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 default implementation must return a range for ERA
from
zero to one, suitable for two era calendar systems such as ISO.
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 supportedpublic static IsoEra valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static IsoEra[] values()
for (IsoEra c : IsoEra.values()) System.out.println(c);