IsoChronology

The ISO calendar system. !(p) This chronology defines the rules of the ISO calendar system. This calendar system is based on the ISO-8601 standard, which is the !(i)de facto</i> world calendar. !(p) The fields are defined as follows: !(ul) !(li)era - There are two eras, 'Current Era' (CE) and 'Before Current Era' (BCE). !(li)year-of-era - The year-of-era is the same as the proleptic-year for the current CE era. For the BCE era before the ISO epoch the year increases from 1 upwards as time goes backwards. !(li)proleptic-year - The proleptic year is the same as the year-of-era for the current era. For the previous era, years have zero, then negative values. !(li)month-of-year - There are 12 months _in an ISO year, numbered from 1 to 12. !(li)day-of-month - There are between 28 and 31 days _in each of the ISO month, numbered from 1 to 31. Months 4, 6, 9 and 11 have 30 days, Months 1, 3, 5, 7, 8, 10 and 12 have 31 days. Month 2 has 28 days, or 29 _in a leap year. !(li)day-of-year - There are 365 days _in a standard ISO year and 366 _in a leap year. The days are numbered from 1 to 365 or 1 to 366. !(li)leap-year - Leap years occur every 4 years, except where the year is divisble by 100 and not divisble by 400. </ul>

@implSpec This class is immutable and thread-safe.

@since 1.8

final
class IsoChronology : AbstractChronology {}

Constructors

this
this()

Restricted constructor.

Members

Functions

compareTo
int compareTo(Chronology other)
Undocumented in source. Be warned that the author may not have intended to support it.
date
LocalDate date(Era 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.

date
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. !(p) This is equivalent to {@link LocalDate#of(int, int, int)}.

date
LocalDate date(TemporalAccessor temporal)

Obtains an ISO local date from another date-time object. !(p) This is equivalent to {@link LocalDate#from(TemporalAccessor)}.

dateEpochDay
LocalDate dateEpochDay(long epochDay)

Obtains an ISO local date from the epoch-day. !(p) This is equivalent to {@link LocalDate#ofEpochDay(long)}.

dateNow
LocalDate dateNow()

Obtains the current ISO local date from the system clock _in the default time-zone. !(p) This will query the {@link Clock#systemDefaultZone() system clock} _in the default time-zone to obtain the current date. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

dateNow
LocalDate dateNow(ZoneId zone)

Obtains the current ISO local date from the system clock _in the specified time-zone. !(p) This will query the {@link Clock#system(ZoneId) system clock} to obtain the current date. Specifying the time-zone avoids dependence on the default time-zone. !(p) Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

dateNow
LocalDate dateNow(Clock clock)

Obtains the current ISO local date from the specified clock. !(p) 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 {@link Clock dependency injection}.

dateYearDay
LocalDate dateYearDay(Era era, int yearOfEra, int dayOfYear)

Obtains an ISO local date from the era, year-of-era and day-of-year fields.

dateYearDay
LocalDate dateYearDay(int prolepticYear, int dayOfYear)

Obtains an ISO local date from the proleptic-year and day-of-year fields. !(p) This is equivalent to {@link LocalDate#ofYearDay(int, int)}.

epochSecond
long epochSecond(int prolepticYear, int month, int dayOfMonth, int hour, int minute, int second, ZoneOffset zoneOffset)

Gets the number of seconds from the epoch of 1970-01-01T00:00:00Z. !(p) The number of seconds is calculated using the year, month, day-of-month, hour, minute, second, and zoneOffset.

epochSecond
long epochSecond(Era era, int yearOfEra, int month, int dayOfMonth, int hour, int minute, int second, ZoneOffset zoneOffset)
Undocumented in source. Be warned that the author may not have intended to support it.
eraOf
IsoEra eraOf(int eraValue)
Undocumented in source. Be warned that the author may not have intended to support it.
eras
List!(Era) eras()
Undocumented in source. Be warned that the author may not have intended to support it.
getCalendarType
string getCalendarType()

Gets the calendar type of the underlying calendar system - 'iso8601'. !(p) The calendar type is an identifier defined by the !(em)Unicode Locale Data Markup Language (LDML)</em> specification. It can be used to lookup the {@code Chronology} using {@link Chronology#of(string)}. It can also be used as part of a locale, accessible via {@link Locale#getUnicodeLocaleType(string)} with the key 'ca'.

getId
string getId()

Gets the ID of the chronology - 'ISO'. !(p) The ID uniquely identifies the {@code Chronology}. It can be used to lookup the {@code Chronology} using {@link Chronology#of(string)}.

isLeapYear
bool isLeapYear(long prolepticYear)

Checks if the year is a leap year, according to the ISO proleptic calendar system rules. !(p) 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. !(p) 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. !(p) 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.

localDateTime
ChronoLocalDateTime!(ChronoLocalDate) localDateTime(TemporalAccessor temporal)

Obtains an ISO local date-time from another date-time object. !(p) This is equivalent to {@link LocalDateTime#from(TemporalAccessor)}.

opCmp
int opCmp(Chronology other)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object obj)

Defend against malicious streams.

period
Period period(int years, int months, int days)

Obtains a period for this chronology based on years, months and days. !(p) This returns a period tied to the ISO chronology using the specified years, months and days. See {@link Period} for further details.

prolepticYear
int prolepticYear(Era era, int yearOfEra)
Undocumented in source. Be warned that the author may not have intended to support it.
range
ValueRange range(ChronoField field)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveDate
LocalDate resolveDate(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)

Resolves parsed {@code ChronoField} values into a date during parsing. !(p) Most {@code TemporalField} implementations are resolved using the resolve method on the field. By contrast, the {@code ChronoField} class defines fields that only have meaning relative to the chronology. As such, {@code ChronoField} date fields are resolved here _in the context of a specific chronology. !(p) {@code ChronoField} instances on the ISO calendar system are resolved as follows. !(ul) !(li){@code EPOCH_DAY} - If present, this is converted to a {@code LocalDate} and all other date fields are then cross-checked against the date. !(li){@code PROLEPTIC_MONTH} - If present, then it is split into the {@code YEAR} and {@code MONTH_OF_YEAR}. If the mode is strict or smart then the field is validated. !(li){@code YEAR_OF_ERA} and {@code ERA} - If both are present, then they are combined to form a {@code YEAR}. In lenient mode, the {@code YEAR_OF_ERA} range is not validated, _in smart and strict mode it is. The {@code ERA} is validated for range _in all three modes. If only the {@code YEAR_OF_ERA} is present, and the mode is smart or lenient, then the current era (CE/AD) is assumed. In strict mode, no era is assumed and the {@code YEAR_OF_ERA} is left untouched. If only the {@code ERA} is present, then it is left untouched. !(li){@code YEAR}, {@code MONTH_OF_YEAR} and {@code DAY_OF_MONTH} - If all three are present, then they are combined to form a {@code LocalDate}. In all three modes, the {@code YEAR} is validated. If the mode is smart or strict, then the month and day are validated, with the day validated from 1 to 31. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first of January _in the requested year, then adding the difference _in months, then the difference _in days. If the mode is smart, and the day-of-month is greater than the maximum for the year-month, then the day-of-month is adjusted to the last day-of-month. If the mode is strict, then the three fields must form a valid date. !(li){@code YEAR} and {@code DAY_OF_YEAR} - If both are present, then they are combined to form a {@code LocalDate}. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first of January _in the requested year, then adding the difference _in days. If the mode is smart or strict, then the two fields must form a valid date. !(li){@code YEAR}, {@code MONTH_OF_YEAR}, {@code ALIGNED_WEEK_OF_MONTH} and {@code ALIGNED_DAY_OF_WEEK_IN_MONTH} - If all four are present, then they are combined to form a {@code LocalDate}. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first of January _in the requested year, then adding the difference _in months, then the difference _in weeks, then _in days. If the mode is smart or strict, then the all four fields are validated to their outer ranges. The date is then combined _in a manner equivalent to creating a date on the first day of the requested year and month, then adding the amount _in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the month. !(li){@code YEAR}, {@code MONTH_OF_YEAR}, {@code ALIGNED_WEEK_OF_MONTH} and {@code DAY_OF_WEEK} - If all four are present, then they are combined to form a {@code LocalDate}. The approach is the same as described above for years, months and weeks _in {@code ALIGNED_DAY_OF_WEEK_IN_MONTH}. The day-of-week is adjusted as the next or same matching day-of-week once the years, months and weeks have been handled. !(li){@code YEAR}, {@code ALIGNED_WEEK_OF_YEAR} and {@code ALIGNED_DAY_OF_WEEK_IN_YEAR} - If all three are present, then they are combined to form a {@code LocalDate}. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first of January _in the requested year, then adding the difference _in weeks, then _in days. If the mode is smart or strict, then the all three fields are validated to their outer ranges. The date is then combined _in a manner equivalent to creating a date on the first day of the requested year, then adding the amount _in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the year. !(li){@code YEAR}, {@code ALIGNED_WEEK_OF_YEAR} and {@code DAY_OF_WEEK} - If all three are present, then they are combined to form a {@code LocalDate}. The approach is the same as described above for years and weeks _in {@code ALIGNED_DAY_OF_WEEK_IN_YEAR}. The day-of-week is adjusted as the next or same matching day-of-week once the years and weeks have been handled. </ul>

resolveProlepticMonth
void resolveProlepticMonth(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYMD
LocalDate resolveYMD(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYearOfEra
LocalDate resolveYearOfEra(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
writeReplace
Object writeReplace()

Writes the Chronology using a <a href="{@docRoot}/serialized-form.html#hunt.time.chrono.Ser">dedicated serialized form</a>. @serialData !(pre) _out.writeByte(1); // identifies a Chronology _out.writeUTF(getId()); </pre>

zonedDateTime
ChronoZonedDateTime!(ChronoLocalDate) zonedDateTime(TemporalAccessor temporal)

Obtains an ISO zoned date-time from another date-time object. !(p) This is equivalent to {@link ZonedDateTime#from(TemporalAccessor)}.

zonedDateTime
ChronoZonedDateTime!(ChronoLocalDate) zonedDateTime(Instant instant, ZoneId zone)

Obtains an ISO zoned date-time _in this chronology from an {@code Instant}. !(p) This is equivalent to {@link ZonedDateTime#ofInstant(Instant, ZoneId)}.

Static functions

INSTANCE
IsoChronology INSTANCE()

Singleton instance of the ISO chronology.

Inherited Members

From AbstractChronology

CHRONOS_BY_TYPE
HashMap!(string, Chronology) CHRONOS_BY_TYPE()

Map of available calendars by calendar type.

registerChrono
Chronology registerChrono(Chronology chrono)

Register a Chronology by its ID and type for lookup by {@link #of(string)}. Chronologies must not be registered until they are completely constructed. Specifically, not _in the constructor of Chronology.

registerChrono
Chronology registerChrono(Chronology chrono, string id)

Register a Chronology by ID and type for lookup by {@link #of(string)}. Chronos must not be registered until they are completely constructed. Specifically, not _in the constructor of Chronology.

ofLocale
Chronology ofLocale(Locale locale)

Obtains an instance of {@code Chronology} from a locale. !(p) See {@link Chronology#ofLocale(Locale)}.

of
Chronology of(string id)

Obtains an instance of {@code Chronology} from a chronology ID or calendar system type. !(p) See {@link Chronology#of(string)}.

getAvailableChronologies
Set!(Chronology) getAvailableChronologies()

Returns the available chronologies. !(p) Each returned {@code Chronology} is available for use _in the system. The set of chronologies includes the system chronologies and any chronologies provided by the application via ServiceLoader configuration.

resolveDate
ChronoLocalDate resolveDate(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)

Resolves parsed {@code ChronoField} values into a date during parsing. <p> Most {@code TemporalField} implementations are resolved using the resolve method on the field. By contrast, the {@code ChronoField} class defines fields that only have meaning relative to the chronology. As such, {@code ChronoField} date fields are resolved here _in the context of a specific chronology. <p> {@code ChronoField} instances are resolved by this method, which may be overridden _in subclasses. <ul> <li>{@code EPOCH_DAY} - If present, this is converted to a date and all other date fields are then cross-checked against the date. <li>{@code PROLEPTIC_MONTH} - If present, then it is split into the {@code YEAR} and {@code MONTH_OF_YEAR}. If the mode is strict or smart then the field is validated. <li>{@code YEAR_OF_ERA} and {@code ERA} - If both are present, then they are combined to form a {@code YEAR}. In lenient mode, the {@code YEAR_OF_ERA} range is not validated, _in smart and strict mode it is. The {@code ERA} is validated for range _in all three modes. If only the {@code YEAR_OF_ERA} is present, and the mode is smart or lenient, then the last available era is assumed. In strict mode, no era is assumed and the {@code YEAR_OF_ERA} is left untouched. If only the {@code ERA} is present, then it is left untouched. <li>{@code YEAR}, {@code MONTH_OF_YEAR} and {@code DAY_OF_MONTH} - If all three are present, then they are combined to form a date. In all three modes, the {@code YEAR} is validated. If the mode is smart or strict, then the month and day are validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first day of the first month _in the requested year, then adding the difference _in months, then the difference _in days. If the mode is smart, and the day-of-month is greater than the maximum for the year-month, then the day-of-month is adjusted to the last day-of-month. If the mode is strict, then the three fields must form a valid date. <li>{@code YEAR} and {@code DAY_OF_YEAR} - If both are present, then they are combined to form a date. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first day of the requested year, then adding the difference _in days. If the mode is smart or strict, then the two fields must form a valid date. <li>{@code YEAR}, {@code MONTH_OF_YEAR}, {@code ALIGNED_WEEK_OF_MONTH} and {@code ALIGNED_DAY_OF_WEEK_IN_MONTH} - If all four are present, then they are combined to form a date. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first day of the first month _in the requested year, then adding the difference _in months, then the difference _in weeks, then _in days. If the mode is smart or strict, then the all four fields are validated to their outer ranges. The date is then combined _in a manner equivalent to creating a date on the first day of the requested year and month, then adding the amount _in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the month. <li>{@code YEAR}, {@code MONTH_OF_YEAR}, {@code ALIGNED_WEEK_OF_MONTH} and {@code DAY_OF_WEEK} - If all four are present, then they are combined to form a date. The approach is the same as described above for years, months and weeks _in {@code ALIGNED_DAY_OF_WEEK_IN_MONTH}. The day-of-week is adjusted as the next or same matching day-of-week once the years, months and weeks have been handled. <li>{@code YEAR}, {@code ALIGNED_WEEK_OF_YEAR} and {@code ALIGNED_DAY_OF_WEEK_IN_YEAR} - If all three are present, then they are combined to form a date. In all three modes, the {@code YEAR} is validated. If the mode is lenient, then the date is combined _in a manner equivalent to creating a date on the first day of the requested year, then adding the difference _in weeks, then _in days. If the mode is smart or strict, then the all three fields are validated to their outer ranges. The date is then combined _in a manner equivalent to creating a date on the first day of the requested year, then adding the amount _in weeks and days to reach their values. If the mode is strict, the date is additionally validated to check that the day and week adjustment did not change the year. <li>{@code YEAR}, {@code ALIGNED_WEEK_OF_YEAR} and {@code DAY_OF_WEEK} - If all three are present, then they are combined to form a date. The approach is the same as described above for years and weeks _in {@code ALIGNED_DAY_OF_WEEK_IN_YEAR}. The day-of-week is adjusted as the next or same matching day-of-week once the years and weeks have been handled. </ul> <p> The default implementation is suitable for most calendar systems. If {@link hunt.time.temporal.ChronoField#YEAR_OF_ERA} is found without an {@link hunt.time.temporal.ChronoField#ERA} then the last era _in {@link #eras()} is used. The implementation assumes a 7 day week, that the first day-of-month has the value 1, that first day-of-year has the value 1, and that the first of the month and year always exists.

resolveProlepticMonth
void resolveProlepticMonth(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYearOfEra
ChronoLocalDate resolveYearOfEra(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYMD
ChronoLocalDate resolveYMD(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYD
ChronoLocalDate resolveYD(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYMAA
ChronoLocalDate resolveYMAA(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYMAD
ChronoLocalDate resolveYMAD(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYAA
ChronoLocalDate resolveYAA(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveYAD
ChronoLocalDate resolveYAD(Map!(TemporalField, Long) fieldValues, ResolverStyle resolverStyle)
Undocumented in source. Be warned that the author may not have intended to support it.
resolveAligned
ChronoLocalDate resolveAligned(ChronoLocalDate base, long months, long weeks, long dow)
Undocumented in source. Be warned that the author may not have intended to support it.
addFieldValue
void addFieldValue(Map!(TemporalField, Long) fieldValues, ChronoField field, long value)

Adds a field-value pair to the map, checking for conflicts. !(p) If the field is not already present, then the field-value pair is added to the map. If the field is already present and it has the same value as that specified, no action occurs. If the field is already present and it has a different value to that specified, then an exception is thrown.

compareTo
int compareTo(Chronology other)

Compares this chronology to another chronology. !(p) The comparison order first by the chronology ID string, then by any additional information specific to the subclass. It is "consistent with equals", as defined by {@link Comparable}.

opEquals
bool opEquals(Object obj)

Checks if this chronology is equal to another chronology. <p> The comparison is based on the entire state of the object.

toHash
size_t toHash()

A hash code for this chronology. <p> The hash code should be based on the entire state of the object.

toString
string toString()

Outputs this chronology as a {@code string}, using the chronology ID.

writeReplace
Object writeReplace()

Writes the Chronology using a <a href="{@docRoot}/serialized-form.html#hunt.time.chrono.Ser">dedicated serialized form</a>. <pre> _out.writeByte(1); // identifies this as a Chronology _out.writeUTF(getId()); </pre>

writeExternal
void writeExternal(DataOutput _out)

Defend against malicious streams.

readExternal
Chronology readExternal(DataInput _in)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta