public final class ISOChrono extends Chrono<ISOChrono> implements java.io.Serializable
This chronology defines the rules of the ISO calendar system. This calendar system is based on the ISO-8601 standard, which is the de facto world calendar.
The fields are defined as follows:
Modifier and Type | Field and Description |
---|---|
static Era<ISOChrono> |
ERA_BCE
The singleton instance for the era BCE - 'Before Current Era'.
|
static Era<ISOChrono> |
ERA_CE
The singleton instance for the era CE - 'Current Era'.
|
static ISOChrono |
INSTANCE
Singleton instance of the ISO chronology.
|
Modifier and Type | Method and Description |
---|---|
LocalDate |
date(Era<ISOChrono> era,
int yearOfEra,
int month,
int dayOfMonth)
Obtains an ISO local date from the era, year-of-era, month-of-year
and day-of-month fields.
|
LocalDate |
date(int prolepticYear,
int month,
int dayOfMonth)
Obtains an ISO local date from the proleptic-year, month-of-year
and day-of-month fields.
|
LocalDate |
date(TemporalAccessor temporal)
Obtains an ISO local date from another date-time object.
|
LocalDate |
dateNow()
Obtains the current ISO local date from the system clock in the default time-zone.
|
LocalDate |
dateNow(Clock clock)
Obtains the current ISO local date from the specified clock.
|
LocalDate |
dateNow(ZoneId zone)
Obtains the current ISO local date from the system clock in the specified time-zone.
|
LocalDate |
dateYearDay(Era<ISOChrono> era,
int yearOfEra,
int dayOfYear)
Obtains an ISO local date from the era, year-of-era and day-of-year fields.
|
LocalDate |
dateYearDay(int prolepticYear,
int dayOfYear)
Obtains an ISO local date from the proleptic-year and day-of-year fields.
|
Era<ISOChrono> |
eraOf(int eraValue)
Creates the chronology era object from the numeric value.
|
java.util.List<Era<ISOChrono>> |
eras()
Gets the list of eras for the chronology.
|
java.lang.String |
getCalendarType()
Gets the calendar type of the underlying calendar system - 'iso8601'.
|
java.lang.String |
getId()
Gets the ID of the chronology - 'ISO'.
|
boolean |
isLeapYear(long prolepticYear)
Checks if the year is a leap year, according to the ISO proleptic
calendar system rules.
|
LocalDateTime |
localDateTime(TemporalAccessor temporal)
Obtains an ISO local date-time from another date-time object.
|
int |
prolepticYear(Era<ISOChrono> era,
int yearOfEra)
Calculates the proleptic-year given the era and year-of-era.
|
ValueRange |
range(ChronoField field)
Gets the range of valid values for the specified field.
|
ZonedDateTime |
zonedDateTime(Instant instant,
ZoneId zone)
Obtains an ISO zoned date-time in this chronology from an
Instant . |
ZonedDateTime |
zonedDateTime(TemporalAccessor temporal)
Obtains an ISO zoned date-time from another date-time object.
|
public static final ISOChrono INSTANCE
public static final Era<ISOChrono> ERA_BCE
0
.public java.lang.String getId()
The ID uniquely identifies the Chrono
.
It can be used to lookup the Chrono
using Chrono.of(String)
.
getId
in class Chrono<ISOChrono>
getCalendarType()
public java.lang.String getCalendarType()
The calendar type is an identifier defined by the
Unicode Locale Data Markup Language (LDML) specification.
It can be used to lookup the Chrono
using Chrono.of(String)
.
It can also be used as part of a locale, accessible via
Locale.getUnicodeLocaleType(String)
with the key 'ca'.
getCalendarType
in class Chrono<ISOChrono>
getId()
public LocalDate date(Era<ISOChrono> era, int yearOfEra, int month, int dayOfMonth)
date
in class Chrono<ISOChrono>
era
- the ISO era, not nullyearOfEra
- the ISO year-of-eramonth
- the ISO month-of-yeardayOfMonth
- the ISO day-of-monthDateTimeException
- if unable to create the datepublic LocalDate date(int prolepticYear, int month, int dayOfMonth)
This is equivalent to LocalDate.of(int, int, int)
.
date
in class Chrono<ISOChrono>
prolepticYear
- the ISO proleptic-yearmonth
- the ISO month-of-yeardayOfMonth
- the ISO day-of-monthDateTimeException
- if unable to create the datepublic LocalDate dateYearDay(Era<ISOChrono> era, int yearOfEra, int dayOfYear)
dateYearDay
in class Chrono<ISOChrono>
era
- the ISO era, not nullyearOfEra
- the ISO year-of-eradayOfYear
- the ISO day-of-yearDateTimeException
- if unable to create the datepublic LocalDate dateYearDay(int prolepticYear, int dayOfYear)
This is equivalent to LocalDate.ofYearDay(int, int)
.
dateYearDay
in class Chrono<ISOChrono>
prolepticYear
- the ISO proleptic-yeardayOfYear
- the ISO day-of-yearDateTimeException
- if unable to create the datepublic LocalDate date(TemporalAccessor temporal)
This is equivalent to LocalDate.from(TemporalAccessor)
.
date
in class Chrono<ISOChrono>
temporal
- the date-time object to convert, not nullDateTimeException
- if unable to create the datepublic LocalDateTime localDateTime(TemporalAccessor temporal)
This is equivalent to LocalDateTime.from(TemporalAccessor)
.
localDateTime
in class Chrono<ISOChrono>
temporal
- the date-time object to convert, not nullDateTimeException
- if unable to create the date-timepublic ZonedDateTime zonedDateTime(TemporalAccessor temporal)
This is equivalent to ZonedDateTime.from(TemporalAccessor)
.
zonedDateTime
in class Chrono<ISOChrono>
temporal
- the date-time object to convert, not nullDateTimeException
- if unable to create the date-timepublic ZonedDateTime zonedDateTime(Instant instant, ZoneId zone)
Instant
.
This is equivalent to ZonedDateTime.ofInstant(Instant, ZoneId)
.
zonedDateTime
in class Chrono<ISOChrono>
instant
- the instant to create the date-time from, not nullzone
- the time-zone, not nullDateTimeException
- if the result exceeds the supported rangepublic LocalDate dateNow()
This will query the system clock
in the default
time-zone to obtain the current date.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
dateNow
in class Chrono<ISOChrono>
DateTimeException
- if unable to create the datepublic LocalDate dateNow(ZoneId zone)
This will query the system clock
to obtain the current date.
Specifying the time-zone avoids dependence on the default time-zone.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
dateNow
in class Chrono<ISOChrono>
zone
- the zone ID to use, not nullDateTimeException
- if unable to create the datepublic LocalDate dateNow(Clock clock)
This will query the specified clock to obtain the current date - today.
Using this method allows the use of an alternate clock for testing.
The alternate clock may be introduced using dependency injection
.
dateNow
in class Chrono<ISOChrono>
clock
- the clock to use, not nullDateTimeException
- if unable to create the datepublic boolean isLeapYear(long prolepticYear)
This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.
For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.
The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.
isLeapYear
in class Chrono<ISOChrono>
prolepticYear
- the ISO proleptic year to checkpublic int prolepticYear(Era<ISOChrono> era, int yearOfEra)
Chrono
This combines the era and year-of-era into the single proleptic-year field.
prolepticYear
in class Chrono<ISOChrono>
era
- the era of the correct type for the chronology, not nullyearOfEra
- the chronology year-of-erapublic Era<ISOChrono> eraOf(int eraValue)
Chrono
The era is, conceptually, the largest division of the time-line. Most calendar systems have a single epoch dividing the time-line into two eras. However, some have multiple eras, such as one for the reign of each leader. The exact meaning is determined by the chronology according to the following constraints.
The era in use at 1970-01-01 must have the value 1. Later eras must have sequentially higher values. Earlier eras must have sequentially lower values. Each chronology must refer to an enum or similar singleton to provide the era values.
This method returns the singleton era of the correct type for the specified era value.
public java.util.List<Era<ISOChrono>> eras()
Chrono
Most calendar systems have an era, within which the year has meaning. If the calendar system does not support the concept of eras, an empty list must be returned.
public ValueRange range(ChronoField field)
Chrono
All fields can be expressed as a long
integer.
This method returns an object that describes the valid range for that value.
Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.
This method will return a result whether or not the chronology supports the field.