Module org.threeten.extra

Package org.threeten.extra.chrono

Class CopticChronology

java.lang.Object

java.time.chrono.AbstractChronology

org.threeten.extra.chrono.CopticChronology

All Implemented Interfaces:

java.io.Serializable

public final class CopticChronology
extends java.time.chrono.AbstractChronology
implements java.io.Serializable

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:

• era - There are two eras, the current 'Era of the Martyrs' (AM) and the previous era (BEFORE_AM).
• year-of-era - The year-of-era for the current era increases uniformly from the epoch at year one. For the previous era the year increases from one as time goes backwards.
• 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.
• month-of-year - There are 13 months in a Coptic year, numbered from 1 to 13.
• day-of-month - There are 30 days in each of the first 12 Coptic months, numbered 1 to 30. The 13th month has 5 days, or 6 in a leap year, numbered 1 to 5 or 1 to 6.
• day-of-year - There are 365 days in a standard Coptic year and 366 in a leap year. The days are numbered from 1 to 365 or 1 to 366.
• leap-year - Leap years occur every 4 years.

Implementation Requirements

This class is immutable and thread-safe.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static CopticChronology	INSTANCE	Singleton instance for the Coptic chronology.

Constructor Summary

Constructors

Constructor	Description
CopticChronology()	Deprecated. Use the singleton INSTANCE instead.

Method Summary

Modifier and Type	Method	Description
CopticDate	date(int prolepticYear, int month, int dayOfMonth)	Obtains a local date in Coptic calendar system from the proleptic-year, month-of-year and day-of-month fields.
CopticDate	date(java.time.chrono.Era era, int yearOfEra, int month, int dayOfMonth)	Obtains a local date in Coptic calendar system from the era, year-of-era, month-of-year and day-of-month fields.
CopticDate	date(java.time.temporal.TemporalAccessor temporal)	Obtains a Coptic local date from another date-time object.
CopticDate	dateEpochDay(long epochDay)	Obtains a local date in the Coptic calendar system from the epoch-day.
CopticDate	dateNow()	Obtains the current Coptic local date from the system clock in the default time-zone.
CopticDate	dateNow(java.time.Clock clock)	Obtains the current Coptic local date from the specified clock.
CopticDate	dateNow(java.time.ZoneId zone)	Obtains the current Coptic local date from the system clock in the specified time-zone.
CopticDate	dateYearDay(int prolepticYear, int dayOfYear)	Obtains a local date in Coptic calendar system from the proleptic-year and day-of-year fields.
CopticDate	dateYearDay(java.time.chrono.Era era, int yearOfEra, int dayOfYear)	Obtains a local date in Coptic calendar system from the era, year-of-era and day-of-year fields.
CopticEra	eraOf(int eraValue)
java.util.List<java.time.chrono.Era>	eras()
java.lang.String	getCalendarType()	Gets the calendar type of the underlying calendar system - 'coptic'.
java.lang.String	getId()	Gets the ID of the chronology - 'Coptic'.
boolean	isLeapYear(long prolepticYear)	Checks if the specified year is a leap year.
java.time.chrono.ChronoLocalDateTime<CopticDate>	localDateTime(java.time.temporal.TemporalAccessor temporal)	Obtains a Coptic local date-time from another date-time object.
int	prolepticYear(java.time.chrono.Era era, int yearOfEra)
java.time.temporal.ValueRange	range(java.time.temporal.ChronoField field)
CopticDate	resolveDate(java.util.Map<java.time.temporal.TemporalField,java.lang.Long> fieldValues, java.time.format.ResolverStyle resolverStyle)
java.time.chrono.ChronoZonedDateTime<CopticDate>	zonedDateTime(java.time.Instant instant, java.time.ZoneId zone)	Obtains a Coptic zoned date-time in this chronology from an Instant.
java.time.chrono.ChronoZonedDateTime<CopticDate>	zonedDateTime(java.time.temporal.TemporalAccessor temporal)	Obtains a Coptic zoned date-time from another date-time object.

Methods inherited from class java.time.chrono.AbstractChronology

compareTo, equals, hashCode, toString

Methods inherited from interface java.time.chrono.Chronology

epochSecond, epochSecond, from, getDisplayName, period

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

public static final CopticChronology INSTANCE

Singleton instance for the Coptic chronology.

Constructor Detail

CopticChronology

@Deprecated
public CopticChronology()

Deprecated. Use the singleton INSTANCE instead.

Private constructor, that is public to satisfy the ServiceLoader.

Method Detail

getId

public java.lang.String 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:

the chronology ID - 'Coptic'

See Also:

getCalendarType()

getCalendarType

public java.lang.String 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:

the calendar system type - 'coptic'

See Also:

getId()

date

public CopticDate date(java.time.chrono.Era era,
                       int yearOfEra,
                       int month,
                       int dayOfMonth)

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

Parameters:

era - the Coptic era, not null

yearOfEra - the year-of-era

month - the month-of-year

dayOfMonth - the day-of-month

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

java.lang.ClassCastException - if the era is not a CopticEra

date

public CopticDate date(int prolepticYear,
                       int month,
                       int dayOfMonth)

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

Parameters:

prolepticYear - the proleptic-year

month - the month-of-year

dayOfMonth - the day-of-month

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateYearDay

public CopticDate dateYearDay(java.time.chrono.Era era,
                              int yearOfEra,
                              int dayOfYear)

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

Parameters:

era - the Coptic era, not null

yearOfEra - the year-of-era

dayOfYear - the day-of-year

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

java.lang.ClassCastException - if the era is not a CopticEra

dateYearDay

public CopticDate dateYearDay(int prolepticYear,
                              int dayOfYear)

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

Parameters:

prolepticYear - the proleptic-year

dayOfYear - the day-of-year

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateEpochDay

public CopticDate dateEpochDay(long epochDay)

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

Parameters:

epochDay - the epoch day

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public CopticDate 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:

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

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public CopticDate dateNow(java.time.ZoneId zone)

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 - the zone ID to use, not null

Returns:

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

Throws:

java.time.DateTimeException - if unable to create the date

dateNow

public CopticDate dateNow(java.time.Clock clock)

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 - the clock to use, not null

Returns:

the current Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

date

public CopticDate date(java.time.temporal.TemporalAccessor temporal)

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

Parameters:

temporal - the date-time object to convert, not null

Returns:

the Coptic local date, not null

Throws:

java.time.DateTimeException - if unable to create the date

localDateTime

public java.time.chrono.ChronoLocalDateTime<CopticDate> localDateTime(java.time.temporal.TemporalAccessor temporal)

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

Parameters:

temporal - the date-time object to convert, not null

Returns:

the Coptic local date-time, not null

Throws:

java.time.DateTimeException - if unable to create the date-time

zonedDateTime

public java.time.chrono.ChronoZonedDateTime<CopticDate> zonedDateTime(java.time.temporal.TemporalAccessor temporal)

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

Parameters:

temporal - the date-time object to convert, not null

Returns:

the Coptic zoned date-time, not null

Throws:

java.time.DateTimeException - if unable to create the date-time

zonedDateTime

public java.time.chrono.ChronoZonedDateTime<CopticDate> zonedDateTime(java.time.Instant instant,
                                                                      java.time.ZoneId zone)

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

Parameters:

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

zone - the time-zone, not null

Returns:

the Coptic zoned date-time, not null

Throws:

java.time.DateTimeException - if the result exceeds the supported range

prolepticYear

public int prolepticYear(java.time.chrono.Era era,
                         int yearOfEra)

eraOf

public CopticEra eraOf(int eraValue)

eras

public java.util.List<java.time.chrono.Era> eras()

resolveDate

public CopticDate resolveDate(java.util.Map<java.time.temporal.TemporalField,java.lang.Long> fieldValues,
                              java.time.format.ResolverStyle resolverStyle)

Overrides:

resolveDate in class java.time.chrono.AbstractChronology

isLeapYear

public boolean isLeapYear(long prolepticYear)

Checks if the specified year is a leap year.

The proleptic-year is leap if the remainder after division by four equals three. This method does not validate the year passed in, and only has a well-defined result for years in the supported range.

Parameters:

prolepticYear - the proleptic-year to check, not validated for range

Returns:

true if the year is a leap year

range

public java.time.temporal.ValueRange range(java.time.temporal.ChronoField field)