org.threeten.bp.chrono
Class IsoChronology

java.lang.Object
  extended by org.threeten.bp.chrono.Chronology
      extended by org.threeten.bp.chrono.IsoChronology
All Implemented Interfaces:
Serializable, Comparable<Chronology>

public final class IsoChronology
extends Chronology
implements Serializable

The ISO calendar system.

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:

Specification for implementors

This class is immutable and thread-safe.

See Also:
Serialized Form

Field Summary
static IsoChronology INSTANCE
          Singleton instance of the ISO chronology.
 
Fields inherited from class org.threeten.bp.chrono.Chronology
FROM
 
Method Summary
 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.
 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 dateEpochDay(long epochDay)
          Obtains a local date in this chronology from the epoch-day.
 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 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.
 IsoEra eraOf(int eraValue)
          Creates the chronology era object from the numeric value.
 List<Era> eras()
          Gets the list of eras for the chronology.
 String getCalendarType()
          Gets the calendar type of the underlying calendar system - 'iso8601'.
 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 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.
 LocalDate resolveDate(Map<TemporalField,Long> fieldValues, ResolverStyle resolverStyle)
          Resolves parsed ChronoField values into a date during parsing.
 ZonedDateTime zonedDateTime(Instant instant, ZoneId zone)
          Obtains an ISO zoned date-time from an instant.
 ZonedDateTime zonedDateTime(TemporalAccessor temporal)
          Obtains an ISO zoned date-time from another date-time object.
 
Methods inherited from class org.threeten.bp.chrono.Chronology
compareTo, equals, from, getAvailableChronologies, getDisplayName, hashCode, of, ofLocale, period, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INSTANCE

public static final IsoChronology INSTANCE
Singleton instance of the ISO chronology.

Method Detail

getId

public String getId()
Gets the ID of the chronology - 'ISO'.

The ID uniquely identifies the Chronology. It can be used to lookup the Chronology using Chronology.of(String).

Specified by:
getId in class Chronology
Returns:
the chronology ID - 'ISO'
See Also:
getCalendarType()

getCalendarType

public String getCalendarType()
Gets the calendar type of the underlying calendar system - 'iso8601'.

The calendar type is an identifier defined by the Unicode Locale Data Markup Language (LDML) specification. It can be used to lookup the Chronology using Chronology.of(String). It can also be used as part of a locale, accessible via Locale#getUnicodeLocaleType(String) with the key 'ca'.

Specified by:
getCalendarType in class Chronology
Returns:
the calendar system type - 'iso8601'
See Also:
getId()

date

public 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.

Overrides:
date in class Chronology
Parameters:
era - the ISO era, not null
yearOfEra - the ISO year-of-era
month - the ISO month-of-year
dayOfMonth - the ISO day-of-month
Returns:
the ISO local date, not null
Throws:
DateTimeException - if unable to create the date

date

public 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.

This is equivalent to LocalDate.of(int, int, int).

Specified by:
date in class Chronology
Parameters:
prolepticYear - the ISO proleptic-year
month - the ISO month-of-year
dayOfMonth - the ISO day-of-month
Returns:
the ISO local date, not null
Throws:
DateTimeException - if unable to create the date

dateYearDay

public LocalDate dateYearDay(Era era,
                             int yearOfEra,
                             int dayOfYear)
Obtains an ISO local date from the era, year-of-era and day-of-year fields.

Overrides:
dateYearDay in class Chronology
Parameters:
era - the ISO era, not null
yearOfEra - the ISO year-of-era
dayOfYear - the ISO day-of-year
Returns:
the ISO local date, not null
Throws:
DateTimeException - if unable to create the date

dateYearDay

public LocalDate dateYearDay(int prolepticYear,
                             int dayOfYear)
Obtains an ISO local date from the proleptic-year and day-of-year fields.

This is equivalent to LocalDate.ofYearDay(int, int).

Specified by:
dateYearDay in class Chronology
Parameters:
prolepticYear - the ISO proleptic-year
dayOfYear - the ISO day-of-year
Returns:
the ISO local date, not null
Throws:
DateTimeException - if unable to create the date

dateEpochDay

public LocalDate dateEpochDay(long epochDay)
Description copied from class: Chronology
Obtains a local date in this chronology from the epoch-day.

The definition of EPOCH_DAY is the same for all calendar systems, thus it can be used for conversion.

Specified by:
dateEpochDay in class Chronology
Parameters:
epochDay - the epoch day
Returns:
the local date in this chronology, not null

date

public LocalDate date(TemporalAccessor temporal)
Obtains an ISO local date from another date-time object.

This is equivalent to LocalDate.from(TemporalAccessor).

Specified by:
date in class Chronology
Parameters:
temporal - the date-time object to convert, not null
Returns:
the ISO local date, not null
Throws:
DateTimeException - if unable to create the date

localDateTime

public LocalDateTime localDateTime(TemporalAccessor temporal)
Obtains an ISO local date-time from another date-time object.

This is equivalent to LocalDateTime.from(TemporalAccessor).

Overrides:
localDateTime in class Chronology
Parameters:
temporal - the date-time object to convert, not null
Returns:
the ISO local date-time, not null
Throws:
DateTimeException - if unable to create the date-time

zonedDateTime

public ZonedDateTime zonedDateTime(TemporalAccessor temporal)
Obtains an ISO zoned date-time from another date-time object.

This is equivalent to ZonedDateTime.from(TemporalAccessor).

Overrides:
zonedDateTime in class Chronology
Parameters:
temporal - the date-time object to convert, not null
Returns:
the ISO zoned date-time, not null
Throws:
DateTimeException - if unable to create the date-time

zonedDateTime

public ZonedDateTime zonedDateTime(Instant instant,
                                   ZoneId zone)
Obtains an ISO zoned date-time from an instant.

This is equivalent to ZonedDateTime.ofInstant(Instant, ZoneId).

Overrides:
zonedDateTime in class Chronology
Parameters:
instant - the instant to convert, not null
zone - the zone to use, not null
Returns:
the ISO zoned date-time, not null
Throws:
DateTimeException - if unable to create the date-time

dateNow

public LocalDate dateNow()
Obtains the current ISO local date from the system clock in the default time-zone.

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.

Overrides:
dateNow in class Chronology
Returns:
the current ISO local date using the system clock and default time-zone, not null
Throws:
DateTimeException - if unable to create the date

dateNow

public LocalDate dateNow(ZoneId zone)
Obtains the current ISO local date from the system clock in the specified time-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.

Overrides:
dateNow in class Chronology
Parameters:
zone - the zone ID to use, not null
Returns:
the current ISO local date using the system clock, not null
Throws:
DateTimeException - if unable to create the date

dateNow

public LocalDate dateNow(Clock clock)
Obtains the current ISO local date from the specified 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.

Overrides:
dateNow in class Chronology
Parameters:
clock - the clock to use, not null
Returns:
the current ISO local date, not null
Throws:
DateTimeException - if unable to create the date

isLeapYear

public boolean isLeapYear(long prolepticYear)
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.

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.

Specified by:
isLeapYear in class Chronology
Parameters:
prolepticYear - the ISO proleptic year to check
Returns:
true if the year is leap, false otherwise

prolepticYear

public int prolepticYear(Era era,
                         int yearOfEra)
Description copied from class: Chronology
Calculates the proleptic-year given the era and year-of-era.

This combines the era and year-of-era into the single proleptic-year field.

Specified by:
prolepticYear in class Chronology
Parameters:
era - the era of the correct type for the chronology, not null
yearOfEra - the chronology year-of-era
Returns:
the proleptic-year

eraOf

public IsoEra eraOf(int eraValue)
Description copied from class: Chronology
Creates the chronology era object from the numeric value.

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.

Specified by:
eraOf in class Chronology
Parameters:
eraValue - the era value
Returns:
the calendar system era, not null

eras

public List<Era> eras()
Description copied from class: Chronology
Gets the list of eras for the chronology.

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.

Specified by:
eras in class Chronology
Returns:
the list of eras for the chronology, may be immutable, not null

range

public ValueRange range(ChronoField field)
Description copied from class: Chronology
Gets the range of valid values for the specified field.

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.

Specified by:
range in class Chronology
Parameters:
field - the field to get the range for, not null
Returns:
the range of valid values for the field, not null

resolveDate

public LocalDate resolveDate(Map<TemporalField,Long> fieldValues,
                             ResolverStyle resolverStyle)
Description copied from class: Chronology
Resolves parsed ChronoField values into a date during parsing.

Most TemporalField implementations are resolved using the resolve method on the field. By contrast, the ChronoField class defines fields that only have meaning relative to the chronology. As such, ChronoField date fields are resolved here in the context of a specific chronology.

The default implementation, which explains typical resolve behaviour, is provided in AbstractChronology.

Specified by:
resolveDate in class Chronology
Parameters:
fieldValues - the map of fields to values, which can be updated, not null
resolverStyle - the requested type of resolve, not null
Returns:
the resolved date, null if insufficient information to create a date


Copyright © 2007–2017 ThreeTen.org. All rights reserved.