Chrono (ThreeTen backport 0.7.2 API)

java.lang.Object
- org.threeten.bp.temporal.Chrono<C>

Type Parameters:
C - the type of the implementing subclass

All Implemented Interfaces:

Comparable<Chrono<?>>

Direct Known Subclasses:

HijrahChrono, ISOChrono, JapaneseChrono, MinguoChrono, ThaiBuddhistChrono
```
public abstract class Chrono<C extends Chrono<C>>
extends Object
implements Comparable<Chrono<?>>
```
A calendar system, used to organize and identify dates.
The main date and time API is built on the ISO calendar system. This class operates behind the scenes to represent the general concept of a calendar system. For example, the Japanese, Minguo, Thai Buddhist and others.
Most other calendar systems also operate on the shared concepts of year, month and day, linked to the cycles of the Earth around the Sun, and the Moon around the Earth. These shared concepts are defined by ChronoField and are availalbe for use by any Chrono implementation:
```
   LocalDate isoDate = ...
   ChronoLocalDate<ThaiBuddhistChrono> minguoDate = ...
   int isoYear = isoDate.get(ChronoField.YEAR);
   int thaiYear = thaiDate.get(ChronoField.YEAR);
 
```
As shown, although the date objects are in different calendar systems, represented by different Chrono instances, both can be queried using the same constant on ChronoField. For a full discussion of the implications of this, see ChronoLocalDate. In general, the advice is to use the known ISO-based LocalDate, rather than ChronoLocalDate.
While a Chrono object typically uses ChronoField and is based on an era, year-of-era, month-of-year, day-of-month model of a date, this is not required. A Chrono instance may represent a totally different kind of calendar system, such as the Mayan.
In practical terms, the Chrono instance also acts as a factory. The of(String) method allows an instance to be looked up by identifier, while the ofLocale(Locale) method allows lookup by locale.
The Chrono instance provides a set of methods to create ChronoLocalDate instances. The date classes are used to manipulate specific dates.
Adding New Calendars
The set of available chronologies can be extended by applications. Adding a new calendar system requires the writing of an implementation of Chrono, ChronoLocalDate and Era. The majority of the logic specific to the calendar system will be in ChronoLocalDate. The Chrono subclass acts as a factory.
To permit the discovery of additional chronologies, the ServiceLoader is used. A file must be added to the META-INF/services directory with the name 'org.threeten.bp.chrono.Chrono' listing the implementation classes. See the ServiceLoader for more details on service loading. For lookup by id or calendarType, the system provided calendars are found first followed by application provided calendars.
Each chronology must define a chronology ID that is unique within the system. If the chronology represents a calendar system defined by the Unicode Locale Data Markup Language (LDML) specification then that calendar type should also be specified.
Specification for implementors
This class must be implemented with care to ensure other classes operate correctly. All implementations that can be instantiated must be final, immutable and thread-safe. Subclasses should be Serializable wherever possible.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Chrono()
Creates an instance.

Constructors
Modifier	Constructor and Description
`protected`	`Chrono()` Creates an instance.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Chrono<?> other)` Compares this chronology to another chronology.
`ChronoLocalDate<C>`	`date(Era<C> era, int yearOfEra, int month, int dayOfMonth)` Obtains a local date in this chronology from the era, year-of-era, month-of-year and day-of-month fields.
`abstract ChronoLocalDate<C>`	`date(int prolepticYear, int month, int dayOfMonth)` Obtains a local date in this chronology from the proleptic-year, month-of-year and day-of-month fields.
`abstract ChronoLocalDate<C>`	`date(TemporalAccessor temporal)` Obtains a local date in this chronology from another temporal object.
`ChronoLocalDate<C>`	`dateNow()` Obtains the current local date in this chronology from the system clock in the default time-zone.
`ChronoLocalDate<C>`	`dateNow(Clock clock)` Obtains the current local date in this chronology from the specified clock.
`ChronoLocalDate<C>`	`dateNow(ZoneId zone)` Obtains the current local date in this chronology from the system clock in the specified time-zone.
`static <R extends Chrono<R>> ChronoLocalDateTime<R>`	`dateTime(ChronoLocalDate<R> date, LocalTime time)` Obtains a local date-time from the a date and time.
`ChronoLocalDate<C>`	`dateYearDay(Era<C> era, int yearOfEra, int dayOfYear)` Obtains a local date in this chronology from the era, year-of-era and day-of-year fields.
`abstract ChronoLocalDate<C>`	`dateYearDay(int prolepticYear, int dayOfYear)` Obtains a local date in this chronology from the proleptic-year and day-of-year fields.
`ChronoLocalDate<C>`	`ensureChronoLocalDate(Temporal temporal)` Casts the `Temporal` to `ChronoLocalDate` with the same chronology.
`org.threeten.bp.temporal.ChronoLocalDateTimeImpl<C>`	`ensureChronoLocalDateTime(Temporal temporal)` Casts the `Temporal` to `ChronoLocalDateTime` with the same chronology.
`org.threeten.bp.temporal.ChronoZonedDateTimeImpl<C>`	`ensureChronoZonedDateTime(Temporal temporal)` Casts the `Temporal` to `ChronoZonedDateTimeImpl` with the same chronology.
`boolean`	`equals(Object obj)` Checks if this chronology is equal to another chronology.
`abstract Era<C>`	`eraOf(int eraValue)` Creates the chronology era object from the numeric value.
`abstract List<Era<C>>`	`eras()` Gets the list of eras for the chronology.
`static Chrono<?>`	`from(TemporalAccessor temporal)` Obtains an instance of `Chrono` from a temporal object.
`static Set<Chrono<?>>`	`getAvailableChronologies()` Returns the available chronologies.
`abstract String`	`getCalendarType()` Gets the calendar type of the underlying calendar system.
`abstract String`	`getId()` Gets the ID of the chronology.
`String`	`getText(TextStyle style, Locale locale)` Gets the textual representation of this chronology.
`int`	`hashCode()` A hash code for this chronology.
`abstract boolean`	`isLeapYear(long prolepticYear)` Checks if the specified year is a leap year.
`ChronoLocalDateTime<C>`	`localDateTime(TemporalAccessor temporal)` Obtains a local date-time in this chronology from another temporal object.
`static Chrono<?>`	`of(String id)` Obtains an instance of `Chrono` from a chronology ID or calendar system type.
`static Chrono<?>`	`ofLocale(Locale locale)` Obtains an instance of `Chrono` from a locale.
`abstract int`	`prolepticYear(Era<C> era, int yearOfEra)` Calculates the proleptic-year given the era and year-of-era.
`abstract ValueRange`	`range(ChronoField field)` Gets the range of valid values for the specified field.
`String`	`toString()` Outputs this chronology as a `String`, using the ID.
`ChronoZonedDateTime<C>`	`zonedDateTime(Instant instant, ZoneId zone)` Obtains a zoned date-time in this chronology from an `Instant`.
`ChronoZonedDateTime<C>`	`zonedDateTime(TemporalAccessor temporal)` Obtains a zoned date-time in this chronology from another temporal object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Chrono
```
protected Chrono()
```
    Creates an instance.
- Method Detail
  - from
```
public static Chrono<?> from(TemporalAccessor temporal)
```
    Obtains an instance of Chrono from a temporal object.
    A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of Chrono. If the specified temporal object does not have a chronology, ISOChrono is returned.
    The conversion will obtain the chronology using TemporalQueries.chrono().
    This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, Chrono::from.
    
    Parameters:
    temporal - the temporal to convert, not null
    
    Returns:
    the chronology, not null
    
    Throws:
    
    DateTimeException - if unable to convert to an Chrono
  - ofLocale
```
public static Chrono<?> ofLocale(Locale locale)
```
    Obtains an instance of Chrono from a locale.
    The locale can be used to identify a calendar. This uses Locale.getUnicodeLocaleType(String) to obtain the "ca" key to identify the calendar system.
    If the locale does not contain calendar system information, the standard ISO calendar system is used.
    
    Parameters:
    locale - the locale to use to obtain the calendar system, not null
    
    Returns:
    the calendar system associated with the locale, not null
    
    Throws:
    
    DateTimeException - if the locale-specified calendar cannot be found
  - of
```
public static Chrono<?> of(String id)
```
    Obtains an instance of Chrono from a chronology ID or calendar system type.
    This returns a chronology based on either the ID or the type. The chronology ID uniquely identifies the chronology. The calendar system type is defined by the LDML specification.
    The chronology may be a system chronology or a chronology provided by the application via ServiceLoader configuration.
    Since some calendars can be customized, the ID or type typically refers to the default customization. For example, the Gregorian calendar can have multiple cutover dates from the Julian, but the lookup only provides the default cutover date.
    
    Parameters:
    id - the chronology ID or calendar system type, not null
    
    Returns:
    the chronology with the identifier requested, not null
    
    Throws:
    
    DateTimeException - if the chronology cannot be found
  - getAvailableChronologies
```
public static Set<Chrono<?>> getAvailableChronologies()
```
    Returns the available chronologies.
    Each returned Chrono is available for use in the system.
    
    Returns:
    the independent, modifiable set of the available chronology IDs, not null
  - dateTime
```
public static <R extends Chrono<R>> ChronoLocalDateTime<R> dateTime(ChronoLocalDate<R> date,
                                                    LocalTime time)
```
    Obtains a local date-time from the a date and time.
    This combines a ChronoLocalDate, which provides the Chrono, with a LocalTime to produce a ChronoLocalDateTime.
    This method is intended for chronology implementations. It uses a standard implementation that is shared for all chronologies.
    
    Type Parameters:
    R - the chronology of the date
    Parameters:
    date - the date, not null
    time - the time, not null
    
    Returns:
    the local date-time combining the input date and time, not null
  - ensureChronoLocalDate
```
public ChronoLocalDate<C> ensureChronoLocalDate(Temporal temporal)
```
    Casts the Temporal to ChronoLocalDate with the same chronology.
    
    Parameters:
    temporal - a date-time to cast, not null
    
    Returns:
    the date-time checked and cast to ChronoLocalDate, not null
    
    Throws:
    
    ClassCastException - if the date-time cannot be cast to ChronoLocalDate or the chronology is not equal this Chrono
  - ensureChronoLocalDateTime
```
public org.threeten.bp.temporal.ChronoLocalDateTimeImpl<C> ensureChronoLocalDateTime(Temporal temporal)
```
    Casts the Temporal to ChronoLocalDateTime with the same chronology.
    
    Parameters:
    temporal - a date-time to cast, not null
    
    Returns:
    the date-time checked and cast to ChronoLocalDateTime, not null
    
    Throws:
    
    ClassCastException - if the date-time cannot be cast to ChronoLocalDateTimeImpl or the chronology is not equal this Chrono
  - ensureChronoZonedDateTime
```
public org.threeten.bp.temporal.ChronoZonedDateTimeImpl<C> ensureChronoZonedDateTime(Temporal temporal)
```
    Casts the Temporal to ChronoZonedDateTimeImpl with the same chronology.
    
    Parameters:
    temporal - a date-time to cast, not null
    
    Returns:
    the date-time checked and cast to ChronoZonedDateTimeImpl, not null
    
    Throws:
    
    ClassCastException - if the date-time cannot be cast to ChronoZonedDateTimeImpl or the chronology is not equal this Chrono
  - getId
```
public abstract String getId()
```
    Gets the ID of the chronology.
    The ID uniquely identifies the Chrono. It can be used to lookup the Chrono using of(String).
    
    Returns:
    the chronology ID, not null
    See Also:
    getCalendarType()
  - getCalendarType
```
public abstract String getCalendarType()
```
    Gets the calendar type of the underlying calendar system.
    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 of(String). It can also be used as part of a locale, accessible via Locale.getUnicodeLocaleType(String) with the key 'ca'.
    
    Returns:
    the calendar system type, null if the calendar is not defined by LDML
    See Also:
    getId()
  - date
```
public ChronoLocalDate<C> date(Era<C> era,
                      int yearOfEra,
                      int month,
                      int dayOfMonth)
```
    Obtains a local date in this chronology from the era, year-of-era, month-of-year and day-of-month fields.
    
    Parameters:
    era - the era of the correct type for the chronology, not null
    yearOfEra - the chronology year-of-era
    month - the chronology month-of-year
    dayOfMonth - the chronology day-of-month
    
    Returns:
    the local date in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - date
```
public abstract ChronoLocalDate<C> date(int prolepticYear,
                      int month,
                      int dayOfMonth)
```
    Obtains a local date in this chronology from the proleptic-year, month-of-year and day-of-month fields.
    
    Parameters:
    prolepticYear - the chronology proleptic-year
    month - the chronology month-of-year
    dayOfMonth - the chronology day-of-month
    
    Returns:
    the local date in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - dateYearDay
```
public ChronoLocalDate<C> dateYearDay(Era<C> era,
                             int yearOfEra,
                             int dayOfYear)
```
    Obtains a local date in this chronology from the era, year-of-era and day-of-year fields.
    
    Parameters:
    era - the era of the correct type for the chronology, not null
    yearOfEra - the chronology year-of-era
    dayOfYear - the chronology day-of-year
    
    Returns:
    the local date in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - dateYearDay
```
public abstract ChronoLocalDate<C> dateYearDay(int prolepticYear,
                             int dayOfYear)
```
    Obtains a local date in this chronology from the proleptic-year and day-of-year fields.
    
    Parameters:
    prolepticYear - the chronology proleptic-year
    dayOfYear - the chronology day-of-year
    
    Returns:
    the local date in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - date
```
public abstract ChronoLocalDate<C> date(TemporalAccessor temporal)
```
    Obtains a local date in this chronology from another temporal object.
    This creates a date in this chronology based on the specified TemporalAccessor.
    The standard mechanism for conversion between date types is the local epoch-day field.
    
    Parameters:
    temporal - the temporal object to convert, not null
    
    Returns:
    the local date in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - dateNow
```
public ChronoLocalDate<C> dateNow()
```
    Obtains the current local date in this chronology 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.
    This implementation uses dateNow(Clock).
    
    Returns:
    the current local date using the system clock and default time-zone, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - dateNow
```
public ChronoLocalDate<C> dateNow(ZoneId zone)
```
    Obtains the current local date in this chronology 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.
    
    Parameters:
    zone - the zone ID to use, not null
    
    Returns:
    the current local date using the system clock, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - dateNow
```
public ChronoLocalDate<C> dateNow(Clock clock)
```
    Obtains the current local date in this chronology 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.
    
    Parameters:
    clock - the clock to use, not null
    
    Returns:
    the current local date, not null
    
    Throws:
    
    DateTimeException - if unable to create the date
  - localDateTime
```
public ChronoLocalDateTime<C> localDateTime(TemporalAccessor temporal)
```
    Obtains a local date-time in this chronology from another temporal object.
    This creates a date-time in this chronology based on the specified TemporalAccessor.
    The date of the date-time should be equivalent to that obtained by calling date(TemporalAccessor). The standard mechanism for conversion between time types is the nano-of-day field.
    
    Parameters:
    temporal - the temporal object to convert, not null
    
    Returns:
    the local date-time in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date-time
  - zonedDateTime
```
public ChronoZonedDateTime<C> zonedDateTime(TemporalAccessor temporal)
```
    Obtains a zoned date-time in this chronology from another temporal object.
    This creates a date-time in this chronology based on the specified TemporalAccessor.
    This should obtain a ZoneId using ZoneId.from(TemporalAccessor). The date-time should be obtained by obtaining an Instant. If that fails, the local date-time should be used.
    
    Parameters:
    temporal - the temporal object to convert, not null
    
    Returns:
    the zoned date-time in this chronology, not null
    
    Throws:
    
    DateTimeException - if unable to create the date-time
  - zonedDateTime
```
public ChronoZonedDateTime<C> zonedDateTime(Instant instant,
                                   ZoneId zone)
```
    Obtains a zoned date-time in this chronology from an Instant.
    This creates a zoned date-time with the same instant as that specified.
    
    Parameters:
    instant - the instant to create the date-time from, not null
    zone - the time-zone, not null
    
    Returns:
    the zoned date-time, not null
    
    Throws:
    
    DateTimeException - if the result exceeds the supported range
  - isLeapYear
```
public abstract boolean isLeapYear(long prolepticYear)
```
    Checks if the specified year is a leap year.
    A leap-year is a year of a longer length than normal. The exact meaning is determined by the chronology according to the following constraints.
    - a leap-year must imply a year-length longer than a non leap-year.
    - a chronology that does not support the concept of a year must return false.
    Parameters:
    prolepticYear - the proleptic-year to check, not validated for range
    
    Returns:
    true if the year is a leap year
  - prolepticYear
```
public abstract int prolepticYear(Era<C> era,
                int yearOfEra)
```
    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.
    
    Parameters:
    era - the era of the correct type for the chronology, not null
    yearOfEra - the chronology year-of-era
    
    Returns:
    the proleptic-year
    
    Throws:
    
    DateTimeException - if unable to convert
  - eraOf
```
public abstract Era<C> eraOf(int eraValue)
```
    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.
    
    Parameters:
    eraValue - the era value
    
    Returns:
    the calendar system era, not null
    
    Throws:
    
    DateTimeException - if unable to create the era
  - eras
```
public abstract List<Era<C>> eras()
```
    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.
    
    Returns:
    the list of eras for the chronology, may be immutable, not null
  - range
```
public abstract ValueRange range(ChronoField field)
```
    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.
    
    Parameters:
    field - the field to get the range for, not null
    
    Returns:
    the range of valid values for the field, not null
    
    Throws:
    
    DateTimeException - if the range for the field cannot be obtained
  - getText
```
public String getText(TextStyle style,
             Locale locale)
```
    Gets the textual representation of this chronology.
    This returns the textual name used to identify the chronology. The parameters control the style of the returned text and the locale.
    
    Parameters:
    style - the style of the text required, not null
    locale - the locale to use, not null
    
    Returns:
    the text value of the chronology, not null
  - compareTo
```
public int compareTo(Chrono<?> other)
```
    Compares this chronology to another chronology.
    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 Comparable.
    The default implementation compares the chronology ID. Subclasses must compare any additional state that they store.
    
    Specified by:
    
    compareTo in interface Comparable<Chrono<?>>
    
    Parameters:
    other - the other chronology to compare to, not null
    
    Returns:
    the comparator value, negative if less, positive if greater
  - equals
```
public boolean equals(Object obj)
```
    Checks if this chronology is equal to another chronology.
    The comparison is based on the entire state of the object.
    The default implementation checks the type and calls compareTo(Chrono).
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to check, null returns false
    
    Returns:
    true if this is equal to the other chronology
  - hashCode
```
public int hashCode()
```
    A hash code for this chronology.
    The default implementation is based on the ID and class. Subclasses should add any additional state that they store.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a suitable hash code
  - toString
```
public String toString()
```
    Outputs this chronology as a String, using the ID.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string representation of this chronology, not null

Class Chrono<C extends Chrono<C>>

Specification for implementors

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Chrono

Method Detail

from

ofLocale

of

getAvailableChronologies

dateTime

ensureChronoLocalDate

ensureChronoLocalDateTime

ensureChronoZonedDateTime

getId

getCalendarType

date

date

dateYearDay

dateYearDay

date

dateNow

dateNow

dateNow

localDateTime

zonedDateTime

zonedDateTime

isLeapYear

prolepticYear

eraOf

eras

range

getText

compareTo

equals

hashCode

toString