Top Description Fields Constructors Methods
org.threeten.extra.chrono

public final Class CopticChronology

extends AbstractNileChronology
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.time.Clock, .DateTimeException, .Instant, .ZoneId, java.time.chrono.ChronoLocalDateTime, .ChronoZonedDateTime, .Chronology, .Era, java.time.format.ResolverStyle, java.time.temporal.TemporalAccessor, .TemporalField, java.util.Arrays, .List, .Locale, .Map

The Coptic calendar system.

This chronology defines the rules of the Coptic calendar system. This calendar system is primarily used in Christian Egypt. Dates are aligned such that 0001-01-01 (Coptic) is 0284-08-29 (ISO).

The fields are defined as follows:

Implementation Requirements

This class is immutable and thread-safe.

Field Summary

Modifier and TypeField and Description
public static final CopticChronology
INSTANCE

Singleton instance for the Coptic chronology.

private static final long
serialVersionUID

Serialization version.

Inherited from org.threeten.extra.chrono.AbstractNileChronology:
ALIGNED_WOM_RANGEDOM_RANGEDOM_RANGE_LEAPDOM_RANGE_NONLEAPMOY_RANGEPROLEPTIC_MONTH_RANGEYEAR_RANGEYOE_RANGE

Constructor Summary

AccessConstructor and Description
public
CopticChronology()
Deprecated Use the singleton INSTANCE instead.

Private constructor, that is public to satisfy the ServiceLoader.

Method Summary

Modifier and TypeMethod and Description
public CopticDate

Returns:

the Coptic local date, not null
date
(Era
the Coptic era, not null
era
,
int
the year-of-era
yearOfEra
,
int
the month-of-year
month
,
int
the day-of-month
dayOfMonth
)

Overrides default java.time.chrono.Chronology.date.

Obtains a local date in Coptic calendar system from the era, year-of-era, month-of-year and day-of-month fields.

public CopticDate

Returns:

the Coptic local date, not null
date
(int
the proleptic-year
prolepticYear
,
int
the month-of-year
month
,
int
the day-of-month
dayOfMonth
)

Implements java.time.chrono.Chronology.date.

Obtains a local date in Coptic calendar system from the proleptic-year, month-of-year and day-of-month fields.

public CopticDate

Returns:

the Coptic local date, not null
date
(TemporalAccessor
the date-time object to convert, not null
temporal
)

Implements java.time.chrono.Chronology.date.

Obtains a Coptic local date from another date-time object.

public CopticDate

Returns:

the Coptic local date, not null
dateEpochDay
(long
the epoch day
epochDay
)

Implements java.time.chrono.Chronology.dateEpochDay.

Obtains a local date in the Coptic calendar system from the epoch-day.

public CopticDate

Returns:

the current Coptic local date using the system clock and default time-zone, not null
dateNow
()

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic local date from the system clock in the default time-zone.

public CopticDate

Returns:

the current Coptic local date using the system clock, not null
dateNow
(ZoneId
the zone ID to use, not null
zone
)

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic local date from the system clock in the specified time-zone.

public CopticDate

Returns:

the current Coptic local date, not null
dateNow
(Clock
the clock to use, not null
clock
)

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic local date from the specified clock.

public CopticDate

Returns:

the Coptic local date, not null
dateYearDay
(Era
the Coptic era, not null
era
,
int
the year-of-era
yearOfEra
,
int
the day-of-year
dayOfYear
)

Overrides default java.time.chrono.Chronology.dateYearDay.

Obtains a local date in Coptic calendar system from the era, year-of-era and day-of-year fields.

public CopticDate

Returns:

the Coptic local date, not null
dateYearDay
(int
the proleptic-year
prolepticYear
,
int
the day-of-year
dayOfYear
)

Implements java.time.chrono.Chronology.dateYearDay.

Obtains a local date in Coptic calendar system from the proleptic-year and day-of-year fields.

public CopticEra
eraOf(int
the era value
eraValue
)

Implements java.time.chrono.Chronology.eraOf.

Creates the chronology era object from the numeric value.

public List<Era>
eras()

Implements java.time.chrono.Chronology.eras.

Gets the list of eras for the chronology.

public String

Returns:

the calendar system type - 'coptic'
getCalendarType
()

Implements java.time.chrono.Chronology.getCalendarType.

Gets the calendar type of the underlying calendar system - 'coptic'.

public String

Returns:

the chronology ID - 'Coptic'
getId
()

Implements java.time.chrono.Chronology.getId.

Gets the ID of the chronology - 'Coptic'.

public ChronoLocalDateTime<CopticDate>

Returns:

the Coptic local date-time, not null
localDateTime
(TemporalAccessor
the date-time object to convert, not null
temporal
)

Overrides default java.time.chrono.Chronology.localDateTime.

Obtains a Coptic local date-time from another date-time object.

public int
prolepticYear(Era
the era of the correct type for the chronology, not null
era
,
int
the chronology year-of-era
yearOfEra
)

Implements java.time.chrono.Chronology.prolepticYear.

Calculates the proleptic-year given the era and year-of-era.

private Object

Returns:

the singleton instance, not null
readResolve
()

Resolve singleton.

public CopticDate
resolveDate(Map<TemporalField, Long>
the map of fields to values, which can be updated, not null
fieldValues
,
ResolverStyle
the requested type of resolve, not null
resolverStyle
)

Overrides java.time.chrono.AbstractChronology.resolveDate.

Implements java.time.chrono.Chronology.resolveDate.

Resolves parsed ChronoField values into a date during parsing.

public ChronoZonedDateTime<CopticDate>

Returns:

the Coptic zoned date-time, not null
zonedDateTime
(TemporalAccessor
the date-time object to convert, not null
temporal
)

Overrides default java.time.chrono.Chronology.zonedDateTime.

Obtains a Coptic zoned date-time from another date-time object.

public ChronoZonedDateTime<CopticDate>

Returns:

the Coptic zoned date-time, not null
zonedDateTime
(Instant
the instant to create the date-time from, not null
instant
,
ZoneId
the time-zone, not null
zone
)

Overrides default java.time.chrono.Chronology.zonedDateTime.

Obtains a Coptic zoned date-time in this chronology from an Instant.

Inherited from org.threeten.extra.chrono.AbstractNileChronology:
isLeapYearrange

Field Detail

INSTANCEback to summary
public static final CopticChronology INSTANCE

Singleton instance for the Coptic chronology.

serialVersionUIDback to summary
private static final long serialVersionUID

Serialization version.

Constructor Detail

CopticChronologyback to summary
public CopticChronology()

Deprecated

Use the singleton INSTANCE instead.

Private constructor, that is public to satisfy the ServiceLoader.

Annotations
@Deprecated

Method Detail

dateback to summary
public CopticDate date(Era era, int yearOfEra, int month, int dayOfMonth)

Overrides default java.time.chrono.Chronology.date.

Obtains a local date in Coptic calendar system from the era, year-of-era, month-of-year and day-of-month fields.

Parameters
era:Era

the Coptic era, not null

yearOfEra:int

the year-of-era

month:int

the month-of-year

dayOfMonth:int

the day-of-month

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
ClassCastException:
if the era is not a CopticEra
dateback to summary
public CopticDate date(int prolepticYear, int month, int dayOfMonth)

Implements java.time.chrono.Chronology.date.

Obtains a local date in Coptic calendar system from the proleptic-year, month-of-year and day-of-month fields.

Parameters
prolepticYear:int

the proleptic-year

month:int

the month-of-year

dayOfMonth:int

the day-of-month

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateback to summary
public CopticDate date(TemporalAccessor temporal)

Implements java.time.chrono.Chronology.date.

Obtains a Coptic local date from another date-time object.

Parameters
temporal:TemporalAccessor

the date-time object to convert, not null

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateEpochDayback to summary
public CopticDate dateEpochDay(long epochDay)

Implements java.time.chrono.Chronology.dateEpochDay.

Obtains a local date in the Coptic calendar system from the epoch-day.

Parameters
epochDay:long

the epoch day

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateNowback to summary
public CopticDate dateNow()

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic 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.

Returns:CopticDate

the current Coptic local date using the system clock and default time-zone, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateNowback to summary
public CopticDate dateNow(ZoneId zone)

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic 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.

Parameters
zone:ZoneId

the zone ID to use, not null

Returns:CopticDate

the current Coptic local date using the system clock, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateNowback to summary
public CopticDate dateNow(Clock clock)

Overrides default java.time.chrono.Chronology.dateNow.

Obtains the current Coptic 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.

Parameters
clock:Clock

the clock to use, not null

Returns:CopticDate

the current Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
dateYearDayback to summary
public CopticDate dateYearDay(Era era, int yearOfEra, int dayOfYear)

Overrides default java.time.chrono.Chronology.dateYearDay.

Obtains a local date in Coptic calendar system from the era, year-of-era and day-of-year fields.

Parameters
era:Era

the Coptic era, not null

yearOfEra:int

the year-of-era

dayOfYear:int

the day-of-year

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
ClassCastException:
if the era is not a CopticEra
dateYearDayback to summary
public CopticDate dateYearDay(int prolepticYear, int dayOfYear)

Implements java.time.chrono.Chronology.dateYearDay.

Obtains a local date in Coptic calendar system from the proleptic-year and day-of-year fields.

Parameters
prolepticYear:int

the proleptic-year

dayOfYear:int

the day-of-year

Returns:CopticDate

the Coptic local date, not null

Annotations
@Override
Exceptions
DateTimeException:
if unable to create the date
eraOfback to summary
public CopticEra eraOf(int eraValue)

Implements java.time.chrono.Chronology.eraOf.

Doc from java.time.chrono.Chronology.eraOf.

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:int

the era value

Returns:CopticEra

the calendar system era, not null

Annotations
@Override
erasback to summary
public List<Era> eras()

Implements java.time.chrono.Chronology.eras.

Doc from java.time.chrono.Chronology.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:List<Era>

the list of eras for the chronology, may be immutable, not null

Annotations
@Override
getCalendarTypeback to summary
public String getCalendarType()

Implements java.time.chrono.Chronology.getCalendarType.

Gets the calendar type of the underlying calendar system - 'coptic'.

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

Returns:String

the calendar system type - 'coptic'

Annotations
@Override
See Also
getId()
getIdback to summary
public String getId()

Implements java.time.chrono.Chronology.getId.

Gets the ID of the chronology - 'Coptic'.

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

Returns:String

the chronology ID - 'Coptic'

Annotations
@Override
See Also
getCalendarType()
localDateTimeback to summary
public ChronoLocalDateTime<CopticDate> localDateTime(TemporalAccessor temporal)

Overrides default java.time.chrono.Chronology.localDateTime.

Obtains a Coptic local date-time from another date-time object.

Parameters
temporal:TemporalAccessor

the date-time object to convert, not null

Returns:ChronoLocalDateTime<CopticDate>

the Coptic local date-time, not null

Annotations
@Override
@SuppressWarnings:unchecked
Exceptions
DateTimeException:
if unable to create the date-time
prolepticYearback to summary
public int prolepticYear(Era era, int yearOfEra)

Implements java.time.chrono.Chronology.prolepticYear.

Doc from java.time.chrono.Chronology.prolepticYear.

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.

If the chronology makes active use of eras, such as JapaneseChronology then the year-of-era will be validated against the era. For other chronologies, validation is optional.

Parameters
era:Era

the era of the correct type for the chronology, not null

yearOfEra:int

the chronology year-of-era

Returns:int

the proleptic-year

Annotations
@Override
readResolveback to summary
private Object readResolve()

Resolve singleton.

Returns:Object

the singleton instance, not null

resolveDateback to summary
public CopticDate resolveDate(Map<TemporalField, Long> fieldValues, ResolverStyle resolverStyle)

Overrides java.time.chrono.AbstractChronology.resolveDate.

Implements java.time.chrono.Chronology.resolveDate.

Doc from java.time.chrono.AbstractChronology.resolveDate.

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.

ChronoField instances are resolved by this method, which may be overridden in subclasses.

  • EPOCH_DAY - If present, this is converted to a date and all other date fields are then cross-checked against the date.
  • PROLEPTIC_MONTH - If present, then it is split into the YEAR and MONTH_OF_YEAR. If the mode is strict or smart then the field is validated.
  • YEAR_OF_ERA and ERA - If both are present, then they are combined to form a YEAR. In lenient mode, the YEAR_OF_ERA range is not validated, in smart and strict mode it is. The ERA is validated for range in all three modes. If only the 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 YEAR_OF_ERA is left untouched. If only the ERA is present, then it is left untouched.
  • YEAR, MONTH_OF_YEAR and DAY_OF_MONTH - If all three are present, then they are combined to form a date. In all three modes, the 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.
  • YEAR and DAY_OF_YEAR - If both are present, then they are combined to form a date. In all three modes, the 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.
  • YEAR, MONTH_OF_YEAR, ALIGNED_WEEK_OF_MONTH and ALIGNED_DAY_OF_WEEK_IN_MONTH - If all four are present, then they are combined to form a date. In all three modes, the 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.
  • YEAR, MONTH_OF_YEAR, ALIGNED_WEEK_OF_MONTH and 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 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.
  • YEAR, ALIGNED_WEEK_OF_YEAR and ALIGNED_DAY_OF_WEEK_IN_YEAR - If all three are present, then they are combined to form a date. In all three modes, the 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.
  • YEAR, ALIGNED_WEEK_OF_YEAR and 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 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.

The default implementation is suitable for most calendar systems. If java.time.temporal.ChronoField#YEAR_OF_ERA is found without an java.time.temporal.ChronoField#ERA then the last era in 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.

Parameters
fieldValues:Map<TemporalField, Long>

the map of fields to values, which can be updated, not null

resolverStyle:ResolverStyle

the requested type of resolve, not null

Returns:CopticDate

the resolved date, null if insufficient information to create a date

Annotations
@Override
zonedDateTimeback to summary
public ChronoZonedDateTime<CopticDate> zonedDateTime(TemporalAccessor temporal)

Overrides default java.time.chrono.Chronology.zonedDateTime.

Obtains a Coptic zoned date-time from another date-time object.

Parameters
temporal:TemporalAccessor

the date-time object to convert, not null

Returns:ChronoZonedDateTime<CopticDate>

the Coptic zoned date-time, not null

Annotations
@Override
@SuppressWarnings:unchecked
Exceptions
DateTimeException:
if unable to create the date-time
zonedDateTimeback to summary
public ChronoZonedDateTime<CopticDate> zonedDateTime(Instant instant, ZoneId zone)

Overrides default java.time.chrono.Chronology.zonedDateTime.

Obtains a Coptic zoned date-time in this chronology from an Instant.

Parameters
instant:Instant

the instant to create the date-time from, not null

zone:ZoneId

the time-zone, not null

Returns:ChronoZonedDateTime<CopticDate>

the Coptic zoned date-time, not null

Annotations
@Override
@SuppressWarnings:unchecked
Exceptions
DateTimeException:
if the result exceeds the supported range