Module org.threeten.extra
Package org.threeten.extra.chrono

Class CopticChronology

  • All Implemented Interfaces:
    Serializable, Comparable<Chronology>, Chronology
    public final class CopticChronology
extends AbstractChronology
implements 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 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 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).

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

      • getCalendarType

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

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

      • date

        public CopticDate date​(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.
        Specified by:
        date in interface Chronology
        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:
        DateTimeException - if unable to create the date
        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.
        Specified by:
        date in interface Chronology
        Parameters:
        prolepticYear - the proleptic-year
        month - the month-of-year
        dayOfMonth - the day-of-month
        Returns:
        the Coptic local date, not null
        Throws:
        DateTimeException - if unable to create the date

      • dateYearDay

        public CopticDate dateYearDay​(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.
        Specified by:
        dateYearDay in interface Chronology
        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:
        DateTimeException - if unable to create the date
        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.
        Specified by:
        dateYearDay in interface Chronology
        Parameters:
        prolepticYear - the proleptic-year
        dayOfYear - the day-of-year
        Returns:
        the Coptic local date, not null
        Throws:
        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.
        Specified by:
        dateEpochDay in interface Chronology
        Parameters:
        epochDay - the epoch day
        Returns:
        the Coptic local date, not null
        Throws:
        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.

        Specified by:
        dateNow in interface Chronology
        Returns:
        the current Coptic local date using the system clock and default time-zone, not null
        Throws:
        DateTimeException - if unable to create the date

      • dateNow

        public CopticDate dateNow​(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.

        Specified by:
        dateNow in interface Chronology
        Parameters:
        zone - the zone ID to use, not null
        Returns:
        the current Coptic local date using the system clock, not null
        Throws:
        DateTimeException - if unable to create the date

      • dateNow

        public CopticDate dateNow​(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.

        Specified by:
        dateNow in interface Chronology
        Parameters:
        clock - the clock to use, not null
        Returns:
        the current Coptic local date, not null
        Throws:
        DateTimeException - if unable to create the date

      • date

        public CopticDate date​(TemporalAccessor temporal)
        Obtains a Coptic local date from another date-time object.
        Specified by:
        date in interface Chronology
        Parameters:
        temporal - the date-time object to convert, not null
        Returns:
        the Coptic local date, not null
        Throws:
        DateTimeException - if unable to create the date

      • zonedDateTime

        public ChronoZonedDateTime<CopticDate> zonedDateTime​(Instant instant,
                                                     ZoneId zone)
        Obtains a Coptic zoned date-time in this chronology from an Instant.
        Specified by:
        zonedDateTime in interface Chronology
        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:
        DateTimeException - if the result exceeds the supported range

      • 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