ChronoHistory (time4j-android 3.6-2015f API)

java.lang.Object
- net.time4j.history.ChronoHistory

All Implemented Interfaces:

java.io.Serializable
```
public final class ChronoHistory
extends java.lang.Object
implements java.io.Serializable
```
Represents the chronological history of calendar reforms in a given region.

Since:

3.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeKey<java.lang.Boolean>`	`ATTRIBUTE_COMMON_ERA` Format attribute which prefers the notation of "Common Era" in formatting an enum of type `HistoricEra`.
`static AttributeKey<PlainDate>`	`ATTRIBUTE_CUTOVER_DATE` Format attribute which can cause the format engine to create a chronological history with given cutover date.
`static AttributeKey<HistoricVariant>`	`ATTRIBUTE_HISTORIC_VARIANT` Format attribute which determines the historical calendar variant.
`static AttributeKey<java.lang.Boolean>`	`ATTRIBUTE_LATIN_ERA` Format attribute which enforces latin notations of historic eras ignoring the locale.
`static ChronoHistory`	`PROLEPTIC_GREGORIAN` Describes no real historical event but just the proleptic gregorian calendar which is assumed to be in power all times.
`static ChronoHistory`	`PROLEPTIC_JULIAN` Describes no real historical event but just the proleptic julian calendar which is assumed to be in power all times.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlainDate`	`convert(HistoricDate date)` Converts given historical date to an ISO-8601-date.
`HistoricDate`	`convert(PlainDate date)` Converts given ISO-8601-date to a historical date.
`TextElement<java.lang.Integer>`	`dayOfMonth()` Defines the element for the historical day of month.
`boolean`	`equals(java.lang.Object obj)`
`TextElement<HistoricEra>`	`era()` Defines the element for the historical era.
`java.util.Set<ChronoElement<?>>`	`getElements()` Yields all associated elements.
`PlainDate`	`getGregorianCutOverDate()` Yields the date of final introduction of gregorian calendar.
`int`	`getLengthOfYear(HistoricEra era, int yearOfEra)` Determines the length of given historical year in days.
`HistoricVariant`	`getVariant()` Yields the variant.
`int`	`hashCode()`
`boolean`	`isValid(HistoricDate date)` Is given historical date valid?
`TextElement<java.lang.Integer>`	`month()` Defines the element for the historical month.
`static ChronoHistory`	`of(java.util.Locale locale)` Determines the history of gregorian calendar reforms for given locale.
`static ChronoHistory`	`ofFirstGregorianReform()` Describes the original switch from julian to gregorian calendar introduced by pope Gregor on 1582-10-15.
`static ChronoHistory`	`ofGregorianReform(PlainDate start)` Describes a single switch from julian to gregorian calendar at given date.
`static ChronoHistory`	`ofSweden()` The Swedish calendar has three cutover dates due to a failed experiment when switching to gregorian calendar in the years 1700-1712 step by step.
`java.lang.String`	`toString()`
`TextElement<java.lang.Integer>`	`yearOfEra()` Defines the element for the year of a given historical era.

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

- Field Detail
  - ATTRIBUTE_HISTORIC_VARIANT
```
public static final AttributeKey<HistoricVariant> ATTRIBUTE_HISTORIC_VARIANT
```
    Format attribute which determines the historical calendar variant.
    
    Users will usually not directly use this attribute but adjust a given ChronoFormatter by its method with(ChronoHistory).
    
    Since:
    
    3.1
    
    See Also:
    
    ChronoFormatter.with(ChronoHistory)
  - ATTRIBUTE_CUTOVER_DATE
```
public static final AttributeKey<PlainDate> ATTRIBUTE_CUTOVER_DATE
```
    Format attribute which can cause the format engine to create a chronological history with given cutover date.
    
    Users will usually not directly use this attribute but adjust a given ChronoFormatter by its method withGregorianCutOver().
    
    See Also:
    
    ChronoFormatter.withGregorianCutOver(PlainDate)
  - ATTRIBUTE_COMMON_ERA
```
public static final AttributeKey<java.lang.Boolean> ATTRIBUTE_COMMON_ERA
```
    Format attribute which prefers the notation of "Common Era" in formatting an enum of type HistoricEra.
    
    Users will usually not directly use this attribute but call the method ChronoFormatter.withAlternativeEraNames() instead.
    
    See Also:
    
    ChronoFormatter.withAlternativeEraNames()
  - ATTRIBUTE_LATIN_ERA
```
public static final AttributeKey<java.lang.Boolean> ATTRIBUTE_LATIN_ERA
```
    Format attribute which enforces latin notations of historic eras ignoring the locale.
    
    Users will usually not directly use this attribute but call the method ChronoFormatter.withLatinEraNames() instead.
    
    See Also:
    
    ChronoFormatter.withLatinEraNames()
  - PROLEPTIC_GREGORIAN
```
public static final ChronoHistory PROLEPTIC_GREGORIAN
```
    Describes no real historical event but just the proleptic gregorian calendar which is assumed to be in power all times.
    
    This constant rather serves for academic purposes. Users will normally use PlainDate without an era.
  - PROLEPTIC_JULIAN
```
public static final ChronoHistory PROLEPTIC_JULIAN
```
    Describes no real historical event but just the proleptic julian calendar which is assumed to be in power all times.
    
    This constant rather serves for academic purposes because the julian calendar is now nowhere in power and has not existed before the calendar reform of Julius Caesar.
- Method Detail
  - ofFirstGregorianReform
```
public static ChronoHistory ofFirstGregorianReform()
```
    Describes the original switch from julian to gregorian calendar introduced by pope Gregor on 1582-10-15.
    
    Returns:
    
    chronological history with cutover to gregorian calendar on 1582-10-15
    
    Since:
    
    3.0
    
    See Also:
    
    ofGregorianReform(PlainDate)
  - ofGregorianReform
```
public static ChronoHistory ofGregorianReform(PlainDate start)
```
    Describes a single switch from julian to gregorian calendar at given date.
    
    Since version 3.1 there are two special cases to consider. If the given date is the maximum/minimum of the date axis then this method will return the proleptic julian/gregorian ChronoHistory.
    
    Parameters:
    
    start - calendar date when the gregorian calendar was introduced
    
    Returns:
    
    new chronological history with only one cutover from julian to gregorian calendar
    
    Throws:
    
    java.lang.IllegalArgumentException - if given date is before first introduction of gregorian calendar on 1582-10-15
    
    Since:
    
    3.0
    
    See Also:
    
    ofFirstGregorianReform()
  - of
```
public static ChronoHistory of(java.util.Locale locale)
```
    Determines the history of gregorian calendar reforms for given locale.
    
    The actual implementation just falls back to the introduction of gregorian calendar by pope Gregor - with the exception of Russia, Sweden and England. Later releases of Time4J will refine the implementation for most European countries. For any cutover date not supported by this method, users can call ofGregorianReform(PlainDate) instead.
    
    This method does not use the language part of given locale but the country part (ISO-3166).
    
    Parameters:
    
    locale - country setting
    
    Returns:
    
    localized chronological history
    
    Since:
    
    3.0
    
    See Also:
    
    ofGregorianReform(PlainDate)
  - ofSweden
```
public static ChronoHistory ofSweden()
```
    The Swedish calendar has three cutover dates due to a failed experiment when switching to gregorian calendar in the years 1700-1712 step by step.
    
    Returns:
    
    swedish chronological history
    
    Since:
    
    3.0
  - isValid
```
public boolean isValid(HistoricDate date)
```
    Is given historical date valid?
    
    If the argument is null then this method returns false.
    
    Parameters:
    
    date - historical calendar date to be checked, maybe null
    
    Returns:
    
    false if given date is invalid else true
    
    Since:
    
    3.0
  - convert
```
public PlainDate convert(HistoricDate date)
```
    Converts given historical date to an ISO-8601-date.
    
    Parameters:
    
    date - historical calendar date
    
    Returns:
    
    ISO-8601-date (gregorian)
    
    Throws:
    
    java.lang.IllegalArgumentException - if given date is invalid
    
    Since:
    
    3.0
  - convert
```
public HistoricDate convert(PlainDate date)
```
    Converts given ISO-8601-date to a historical date.
    
    Parameters:
    
    date - ISO-8601-date (gregorian)
    
    Returns:
    
    historical calendar date
    
    Since:
    
    3.0
  - getVariant
```
public HistoricVariant getVariant()
```
    Yields the variant.
    
    Returns:
    
    HistoricVariant
    
    Since:
    
    3.1
  - getGregorianCutOverDate
```
public PlainDate getGregorianCutOverDate()
```
    Yields the date of final introduction of gregorian calendar.
    
    Returns:
    
    ISO-8601-date (gregorian)
    
    Since:
    
    3.0
  - getLengthOfYear
```
public int getLengthOfYear(HistoricEra era,
                           int yearOfEra)
```
    Determines the length of given historical year in days.
    
    Parameters:
    
    era - historical era
    
    yearOfEra - historical year of era
    
    Returns:
    
    length of historical year in days or -1 if the length cannot be determined
    
    Since:
    
    3.0
  - era
```
public TextElement<HistoricEra> era()
```
    Defines the element for the historical era.
    
    This element is applicable on all chronological types which have registered the element PlainDate.COMPONENT.
    
    Returns:
    
    era-related element
    
    Since:
    
    3.0
    
    See Also:
    
    PlainDate, PlainTimestamp
  - yearOfEra
```
public TextElement<java.lang.Integer> yearOfEra()
```
    Defines the element for the year of a given historical era.
    
    This element is applicable on all chronological types which have registered the element PlainDate.COMPONENT.
    
    Returns:
    
    year-of-era-related element
    
    Since:
    
    3.0
    
    See Also:
    
    PlainDate, PlainTimestamp
  - month
```
public TextElement<java.lang.Integer> month()
```
    Defines the element for the historical month.
    
    This element is applicable on all chronological types which have registered the element PlainDate.COMPONENT.
    
    Returns:
    
    month-related element
    
    Since:
    
    3.0
    
    See Also:
    
    PlainDate, PlainTimestamp
  - dayOfMonth
```
public TextElement<java.lang.Integer> dayOfMonth()
```
    Defines the element for the historical day of month.
    
    This element is applicable on all chronological types which have registered the element PlainDate.COMPONENT.
    
    Returns:
    
    day-of-month-related element
    
    Since:
    
    3.0
    
    See Also:
    
    PlainDate, PlainTimestamp
  - getElements
```
public java.util.Set<ChronoElement<?>> getElements()
```
    Yields all associated elements.
    
    Returns:
    
    unmodifiable set of historical elements
    
    Since:
    
    3.1
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ChronoHistory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTE_HISTORIC_VARIANT

ATTRIBUTE_CUTOVER_DATE

ATTRIBUTE_COMMON_ERA

ATTRIBUTE_LATIN_ERA

PROLEPTIC_GREGORIAN

PROLEPTIC_JULIAN

Method Detail

ofFirstGregorianReform

ofGregorianReform

of

ofSweden

isValid

convert

convert

getVariant

getGregorianCutOverDate

getLengthOfYear

era

yearOfEra

month

dayOfMonth

getElements

equals

hashCode

toString