IslamicCalendar.java

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 *******************************************************************************
 * Copyright (C) 1996-2016, International Business Machines Corporation and    *
 * others. All Rights Reserved.                                                *
 *******************************************************************************
 */
package com.ibm.icu.util;

import com.ibm.icu.impl.CalendarAstronomer;
import com.ibm.icu.impl.CalendarCache;
import com.ibm.icu.impl.CalendarUtil;
import com.ibm.icu.util.ULocale.Category;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.Date;
import java.util.Locale;
import java.util.function.IntConsumer;

/**
 * <code>IslamicCalendar</code> is a subclass of <code>Calendar</code> that that implements the
 * Islamic civil and religious calendars. It is used as the civil calendar in most of the Arab world
 * and the liturgical calendar of the Islamic faith worldwide. This calendar is also known as the
 * "Hijri" calendar, since it starts at the time of Mohammed's emigration (or "hijra") to Medinah on
 * Thursday, July 15, 622 AD (Julian).
 *
 * <p>The Islamic calendar is strictly lunar, and thus an Islamic year of twelve lunar months does
 * not correspond to the solar year used by most other calendar systems, including the Gregorian. An
 * Islamic year is, on average, about 354 days long, so each successive Islamic year starts about 11
 * days earlier in the corresponding Gregorian year.
 *
 * <p>Each month of the calendar starts when the new moon's crescent is visible at sunset. However,
 * in order to keep the time fields in this class synchronized with those of the other calendars and
 * with local clock time, we treat days and months as beginning at midnight, roughly 6 hours after
 * the corresponding sunset.
 *
 * <p>There are three main variants of the Islamic calendar in existence. The first is the
 * <em>civil</em> calendar, which uses a fixed cycle of alternating 29- and 30-day months, with a
 * leap day added to the last month of 11 out of every 30 years. This calendar is easily calculated
 * and thus predictable in advance, so it is used as the civil calendar in a number of Arab
 * countries. This is the default behavior of a newly-created <code>IslamicCalendar</code> object.
 *
 * <p>The Islamic <em>religious</em> calendar and Saudi Arabia's <em>Umm al-Qura</em> calendar,
 * however, are based on the <em>observation</em> of the crescent moon. It is thus affected by the
 * position at which the observations are made, seasonal variations in the time of sunset, the
 * eccentricities of the moon's orbit, and even the weather at the observation site. This makes it
 * impossible to calculate in advance, and it causes the start of a month in the religious calendar
 * to differ from the civil calendar by up to three days.
 *
 * <p>Using astronomical calculations for the position of the sun and moon, the moon's illumination,
 * and other factors, it is possible to determine the start of a lunar month with a fairly high
 * degree of certainty. However, these calculations are extremely complicated and thus slow, so most
 * algorithms, including the one used here, are only approximations of the true astronomical
 * calculations. At present, the approximations used in this class are fairly simplistic; they will
 * be improved in later versions of the code.
 *
 * <p>Like the Islamic religious calendar, <em>Umm al-Qura</em> is also based on the sighting method
 * of the crescent moon but is standardized by Saudi Arabia.
 *
 * <p>The {@link #setCalculationType(CalculationType) setCalculationType} method determines which
 * approach is used to determine the start of a month. By default, the fixed-cycle <em>civil</em>
 * calendar is used. However, if <code>setCalculationType(ISLAMIC)</code> is called, an
 * approximation of the true lunar calendar will be used. Similarly, if <code>
 * setCalculationType(ISLAMIC_UMALQURA)</code> is called, an approximation of the Umm al-Qura lunar
 * calendar will be used.
 *
 * <p>This class should not be subclassed.
 *
 * <p>IslamicCalendar usually should be instantiated using {@link
 * com.ibm.icu.util.Calendar#getInstance(ULocale)} passing in a <code>ULocale</code> with the tag
 * <code>"@calendar=islamic"</code> or <code>"@calendar=islamic-civil"</code> or <code>
 * "@calendar=islamic-umalqura"</code>.
 *
 * @see com.ibm.icu.util.GregorianCalendar
 * @see com.ibm.icu.util.Calendar
 * @author Laura Werner
 * @author Alan Liu
 * @stable ICU 2.8
 */
public class IslamicCalendar extends Calendar {
    // jdk1.4.2 serialver
    private static final long serialVersionUID = -6253365474073869325L;

    // -------------------------------------------------------------------------
    // Constants...
    // -------------------------------------------------------------------------

    /**
     * Constant for Muharram, the 1st month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int MUHARRAM = 0;

    /**
     * Constant for Safar, the 2nd month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int SAFAR = 1;

    /**
     * Constant for Rabi' al-awwal (or Rabi' I), the 3rd month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int RABI_1 = 2;

    /**
     * Constant for Rabi' al-thani or (Rabi' II), the 4th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int RABI_2 = 3;

    /**
     * Constant for Jumada al-awwal or (Jumada I), the 5th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int JUMADA_1 = 4;

    /**
     * Constant for Jumada al-thani or (Jumada II), the 6th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int JUMADA_2 = 5;

    /**
     * Constant for Rajab, the 7th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int RAJAB = 6;

    /**
     * Constant for Sha'ban, the 8th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int SHABAN = 7;

    /**
     * Constant for Ramadan, the 9th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int RAMADAN = 8;

    /**
     * Constant for Shawwal, the 10th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int SHAWWAL = 9;

    /**
     * Constant for Dhu al-Qi'dah, the 11th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int DHU_AL_QIDAH = 10;

    /**
     * Constant for Dhu al-Hijjah, the 12th month of the Islamic year.
     *
     * @stable ICU 2.8
     */
    public static final int DHU_AL_HIJJAH = 11;

    private static final long HIJRA_MILLIS = -42521587200000L; // 7/16/622 AD 00:00

    /** Friday EPOCH */
    private static final long CIVIL_EPOCH =
            1948440; // CE 622 July 16 Friday (Julian calendar) / CE 622 July 19 (Gregorian

    // calendar)

    //
    /** Thursday EPOCH */
    private static final long ASTRONOMICAL_EPOCH =
            1948439; // CE 622 July 15 Thursday (Julian calendar)

    // -------------------------------------------------------------------------
    // Constructors...
    // -------------------------------------------------------------------------

    /**
     * Constructs a default <code>IslamicCalendar</code> using the current time in the default time
     * zone with the default <code>FORMAT</code> locale.
     *
     * @see Category#FORMAT
     * @stable ICU 2.8
     */
    public IslamicCalendar() {
        this(TimeZone.getDefault(), ULocale.getDefault(Category.FORMAT));
    }

    /**
     * Constructs an <code>IslamicCalendar</code> based on the current time in the given time zone
     * with the default <code>FORMAT</code> locale.
     *
     * @param zone the given time zone.
     * @see Category#FORMAT
     * @stable ICU 2.8
     */
    public IslamicCalendar(TimeZone zone) {
        this(zone, ULocale.getDefault(Category.FORMAT));
    }

    /**
     * Constructs an <code>IslamicCalendar</code> based on the current time in the default time zone
     * with the given locale.
     *
     * @param aLocale the given locale.
     * @stable ICU 2.8
     */
    public IslamicCalendar(Locale aLocale) {
        this(TimeZone.forLocaleOrDefault(aLocale), aLocale);
    }

    /**
     * Constructs an <code>IslamicCalendar</code> based on the current time in the default time zone
     * with the given locale.
     *
     * @param locale the given ulocale.
     * @stable ICU 3.2
     */
    public IslamicCalendar(ULocale locale) {
        this(TimeZone.forULocaleOrDefault(locale), locale);
    }

    /**
     * Constructs an <code>IslamicCalendar</code> based on the current time in the given time zone
     * with the given locale.
     *
     * @param zone the given time zone.
     * @param aLocale the given locale.
     * @stable ICU 2.8
     */
    public IslamicCalendar(TimeZone zone, Locale aLocale) {
        this(zone, ULocale.forLocale(aLocale));
    }

    /**
     * Constructs an <code>IslamicCalendar</code> based on the current time in the given time zone
     * with the given locale.
     *
     * @param zone the given time zone.
     * @param locale the given ulocale.
     * @stable ICU 3.2
     */
    public IslamicCalendar(TimeZone zone, ULocale locale) {
        super(zone, locale);
        setCalcTypeForLocale(locale);
        setTimeInMillis(System.currentTimeMillis());
    }

    /**
     * Constructs an <code>IslamicCalendar</code> with the given date set in the default time zone
     * with the default <code>FORMAT</code> locale.
     *
     * @param date The date to which the new calendar is set.
     * @see Category#FORMAT
     * @stable ICU 2.8
     */
    public IslamicCalendar(Date date) {
        super(TimeZone.getDefault(), ULocale.getDefault(Category.FORMAT));
        this.setTime(date);
    }

    /**
     * Constructs an <code>IslamicCalendar</code> with the given date set in the default time zone
     * with the default <code>FORMAT</code> locale.
     *
     * @param year the value used to set the {@link #YEAR YEAR} time field in the calendar.
     * @param month the value used to set the {@link #MONTH MONTH} time field in the calendar. Note
     *     that the month value is 0-based. e.g., 0 for Muharram.
     * @param date the value used to set the {@link #DATE DATE} time field in the calendar.
     * @see Category#FORMAT
     * @stable ICU 2.8
     */
    public IslamicCalendar(int year, int month, int date) {
        super(TimeZone.getDefault(), ULocale.getDefault(Category.FORMAT));
        this.set(Calendar.YEAR, year);
        this.set(Calendar.MONTH, month);
        this.set(Calendar.DATE, date);
    }

    /**
     * Constructs an <code>IslamicCalendar</code> with the given date and time set for the default
     * time zone with the default <code>FORMAT</code> locale.
     *
     * @param year the value used to set the {@link #YEAR YEAR} time field in the calendar.
     * @param month the value used to set the {@link #MONTH MONTH} time field in the calendar. Note
     *     that the month value is 0-based. e.g., 0 for Muharram.
     * @param date the value used to set the {@link #DATE DATE} time field in the calendar.
     * @param hour the value used to set the {@link #HOUR_OF_DAY HOUR_OF_DAY} time field in the
     *     calendar.
     * @param minute the value used to set the {@link #MINUTE MINUTE} time field in the calendar.
     * @param second the value used to set the {@link #SECOND SECOND} time field in the calendar.
     * @see Category#FORMAT
     * @stable ICU 2.8
     */
    public IslamicCalendar(int year, int month, int date, int hour, int minute, int second) {
        super(TimeZone.getDefault(), ULocale.getDefault(Category.FORMAT));
        this.set(Calendar.YEAR, year);
        this.set(Calendar.MONTH, month);
        this.set(Calendar.DATE, date);
        this.set(Calendar.HOUR_OF_DAY, hour);
        this.set(Calendar.MINUTE, minute);
        this.set(Calendar.SECOND, second);
    }

    // Private interface for different Islamic calendar algorithms.
    private interface Algorithm {
        /**
         * Returns <code>true</code> if this object is using the fixed-cycle civil calendar, or
         * <code>false</code> if using the religious, astronomical calendar.
         */
        public boolean isCivil();

        /** Return the type the algorithm implement. */
        public CalculationType getType();

        /** Return the epoch used by this algorithm. */
        public long epoch();

        /**
         * Return the day # on which the given year starts. Days are counted from the Hijri epoch,
         * origin 0.
         *
         * @param year The hijri year
         */
        public long yearStart(int year);

        /**
         * Return the day # on which the given month starts. Days are counted from the Hijri epoch,
         * origin 0.
         *
         * @param year The hijri year
         * @param month The hijri month, 0-based
         */
        public long monthStart(int year, int month);

        /**
         * Return the length (in days) of the given month.
         *
         * @param year The hijri year
         * @param month The hijri month, 0-based
         */
        public int monthLength(int year, int month);

        /**
         * Return the length (in days) of the given year.
         *
         * @param year The hijri year
         */
        public int yearLength(int year);

        /**
         * Compute the year, month, dayOfMonth, and dayOfYear of the given julian days and current
         * time and feed the caculuated results to the consumers.
         *
         * @param julianDays
         * @param current the time in millisecond.
         * @param yearConsumer consumer to take the year result.
         * @param monthConsumer consumer to take the month result.
         * @param dayOfMonthConsumer consumer to take the dayOfMonth result.
         * @param dayOfYearConsumer consumer to take the dayOfYear result.
         */
        public void compute(
                long julianDays,
                long current,
                IntConsumer yearConsumer,
                IntConsumer monthConsumer,
                IntConsumer dayOfMonthConsumer,
                IntConsumer dayOfYearConsumer);
    }
    ;

    /** Algorithm which implement the rules for CalculationType.ISLAMIC. */
    private static class IslamicAlgorithm implements Algorithm {
        @Override
        public boolean isCivil() {
            return false;
        }

        @Override
        public CalculationType getType() {
            return CalculationType.ISLAMIC;
        }

        @Override
        public long epoch() {
            return CIVIL_EPOCH;
        }

        @Override
        public long yearStart(int year) {
            return monthStart(year, 0);
        }

        @Override
        public long monthStart(int year, int month) {
            // Normalize year/month in case month is outside the normal bounds, which may occur
            // in the case of an add operation
            return trueMonthStart(12 * ((year + month / 12) - 1) + (month % 12));
        }

        @Override
        public int monthLength(int year, int month) {
            month += 12 * (year - 1);
            return (int) (trueMonthStart(month + 1) - trueMonthStart(month));
        }

        @Override
        public int yearLength(int year) {
            int month = 12 * (year - 1);
            return (int) (trueMonthStart(month + 12) - trueMonthStart(month));
        }

        @Override
        public void compute(
                long julianDays,
                long current,
                IntConsumer yearConsumer,
                IntConsumer monthConsumer,
                IntConsumer dayOfMonthConsumer,
                IntConsumer dayOfYearConsumer) {
            long days = julianDays - epoch();
            // Guess at the number of elapsed full months since the epoch
            int month = (int) Math.floor(days / CalendarAstronomer.SYNODIC_MONTH);
            long monthStart = (long) Math.floor(month * CalendarAstronomer.SYNODIC_MONTH - 1);
            if (days - monthStart >= 25 && moonAge(current) > 0) {
                // If we're near the end of the month, assume next month and search backwards
                month++;
            }
            // Find out the last time that the new moon was actually visible at this longitude
            // This returns midnight the night that the moon was visible at sunset.
            while ((monthStart = trueMonthStart(month)) > days) {
                // If it was after the date in question, back up a month and try again
                month--;
            }
            int year = month >= 0 ? ((month / 12) + 1) : ((month + 1) / 12);
            month = ((month % 12) + 12) % 12;
            yearConsumer.accept(year);
            monthConsumer.accept(month);
            dayOfMonthConsumer.accept((int) (days - monthStart(year, month)) + 1);
            dayOfYearConsumer.accept((int) (days - yearStart(year) + 1));
        }
    }
    ;

    /** Algorithm which implement the rules for CalculationType.ISLAMIC_CIVIL. */
    private static class CivilAlgorithm implements Algorithm {
        @Override
        public boolean isCivil() {
            return true;
        }

        @Override
        public CalculationType getType() {
            return CalculationType.ISLAMIC_CIVIL;
        }

        @Override
        public long epoch() {
            return CIVIL_EPOCH;
        }

        @Override
        public long yearStart(int year) {
            return (year - 1) * 354 + (long) Math.floor((3 + 11 * year) / 30.0);
        }

        @Override
        public long monthStart(int year, int month) {
            // Normalize year/month in case month is outside the normal bounds, which may occur
            // in the case of an add operation
            return (long) Math.ceil(29.5 * (month % 12)) + yearStart(year + month / 12);
        }

        @Override
        public int monthLength(int year, int month) {
            int length = 29;
            if (month % 2 == 0) {
                ++length;
            }
            if (month == DHU_AL_HIJJAH && civilLeapYear(year)) {
                ++length;
            }
            return length;
        }

        @Override
        public int yearLength(int year) {
            return 354 + (civilLeapYear(year) ? 1 : 0);
        }

        @Override
        public void compute(
                long julianDays,
                long current,
                IntConsumer yearConsumer,
                IntConsumer monthConsumer,
                IntConsumer dayOfMonthConsumer,
                IntConsumer dayOfYearConsumer) {
            long days = julianDays - epoch();
            // Use the civil calendar approximation, which is just arithmetic
            int year = (int) Math.floor((30 * days + 10646) / 10631.0);
            int month = (int) Math.ceil((days - 29 - yearStart(year)) / 29.5);
            month = Math.min(month, 11);
            yearConsumer.accept(year);
            monthConsumer.accept(month);
            dayOfMonthConsumer.accept((int) (days - monthStart(year, month)) + 1);
            dayOfYearConsumer.accept((int) (days - yearStart(year) + 1));
        }
    }
    ;

    /**
     * Algorithm which implement the rules for CalculationType.ISLAMIC_TBLA. Mostly the same as
     * CivilAlgorithm, except it return false for isCivil and use different epoch value.
     */
    private static class TBLAAlgorithm extends CivilAlgorithm {
        @Override
        public boolean isCivil() {
            return false;
        }

        @Override
        public CalculationType getType() {
            return CalculationType.ISLAMIC_TBLA;
        }

        @Override
        public long epoch() {
            return ASTRONOMICAL_EPOCH;
        }
    }
    ;

    /** Algorithm which implement the rules for CalculationType.ISLAMIC_UMALQURA. */
    private static class UmalquraAlgorithm implements Algorithm {
        @Override
        public boolean isCivil() {
            return false;
        }

        @Override
        public CalculationType getType() {
            return CalculationType.ISLAMIC_UMALQURA;
        }

        @Override
        public long epoch() {
            return CIVIL_EPOCH;
        }

        @Override
        public long yearStart(int year) {
            if (year < UMALQURA_YEAR_START || year > UMALQURA_YEAR_END) {
                return CIVIL_ALGORITHM.yearStart(year);
            }
            int index = year - UMALQURA_YEAR_START;
            // rounded least-squares fit of the dates previously calculated from
            // UMALQURA_MONTHLENGTH iteration
            int yrStartLinearEstimate = (int) ((354.36720 * index) + 460322.05 + 0.5);
            // need a slight correction to some
            return yrStartLinearEstimate + UMALQURA_YEAR_START_ESTIMATE_FIX[index];
        }

        @Override
        public long monthStart(int year, int month) {
            // Normalize year/month in case month is outside the normal bounds, which may occur
            // in the case of an add operation
            year += month / 12;
            month %= 12;
            if (year < UMALQURA_YEAR_START) {
                return CIVIL_ALGORITHM.monthStart(year, month);
            }
            long ms = yearStart(year);
            for (int i = 0; i < month; i++) {
                ms += monthLength(year, i);
            }
            return ms;
        }

        @Override
        public int monthLength(int year, int month) {
            if (year < UMALQURA_YEAR_START || year > UMALQURA_YEAR_END) {
                return CIVIL_ALGORITHM.monthLength(year, month);
            }
            int index = (year - UMALQURA_YEAR_START); // calculate year offset into bit map array
            int mask = (0x01 << (11 - month)); // set mask for bit corresponding to month
            if ((UMALQURA_MONTHLENGTH[index] & mask) != 0) {
                return 30;
            }
            return 29;
        }

        @Override
        public int yearLength(int year) {
            if (year < UMALQURA_YEAR_START || year > UMALQURA_YEAR_END) {
                return CIVIL_ALGORITHM.yearLength(year);
            }
            int length = 0;
            for (int i = 0; i < 12; i++) {
                length += monthLength(year, i);
            }
            return length;
        }

        @Override
        public void compute(
                long julianDays,
                long current,
                IntConsumer yearConsumer,
                IntConsumer monthConsumer,
                IntConsumer dayOfMonthConsumer,
                IntConsumer dayOfYearConsumer) {
            long days = julianDays - epoch();
            if (days < yearStart(UMALQURA_YEAR_START)) {
                CIVIL_ALGORITHM.compute(
                        julianDays,
                        current,
                        yearConsumer,
                        monthConsumer,
                        dayOfMonthConsumer,
                        dayOfYearConsumer);
                return;
            }
            // Estimate a value y which is closer to but not greater than the year.
            // It is the inverse function of the logic inside yearStart() about the
            // linear estimate.
            int year = (int) ((days - (460322.05 + 0.5)) / 354.36720) + UMALQURA_YEAR_START - 1;
            int month = 0;
            long monthStart;
            long d = 1;
            while (d > 0) {
                year++;
                d = days - yearStart(year) + 1;
                int yearLength = yearLength(year);
                if (d == yearLength) {
                    month = 11;
                    break;
                } else if (d < yearLength) {
                    int monthLen = monthLength(year, month);
                    for (month = 0; d > monthLen; monthLen = monthLength(year, ++month)) {
                        d -= monthLen;
                    }
                    break;
                }
            }
            yearConsumer.accept(year);
            monthConsumer.accept(month);
            dayOfMonthConsumer.accept((int) (days - monthStart(year, month)) + 1);
            dayOfYearConsumer.accept((int) (days - yearStart(year) + 1));
        }
    }
    ;

    private static Algorithm ISLAMIC_ALGORITHM;
    private static Algorithm CIVIL_ALGORITHM;
    private static Algorithm TBLA_ALGORITHM;
    private static Algorithm UMALQURA_ALGORITHM;

    static {
        ISLAMIC_ALGORITHM = new IslamicAlgorithm();
        CIVIL_ALGORITHM = new CivilAlgorithm();
        TBLA_ALGORITHM = new TBLAAlgorithm();
        UMALQURA_ALGORITHM = new UmalquraAlgorithm();
    }
    ;

    /**
     * Determines whether this object uses the fixed-cycle Islamic civil calendar or an
     * approximation of the religious, astronomical calendar.
     *
     * @param beCivil <code>true</code> to use the civil calendar, <code>false</code> to use the
     *     astronomical calendar.
     * @stable ICU 2.8
     * @discouraged ICU 57 use setCalculationType(CalculationType) instead
     */
    public void setCivil(boolean beCivil) {
        if (beCivil && cType != CalculationType.ISLAMIC_CIVIL) {
            // The fields of the calendar will become invalid, because the calendar
            // rules are different
            long m = getTimeInMillis();
            cType = CalculationType.ISLAMIC_CIVIL;
            algorithm = CIVIL_ALGORITHM;
            clear();
            setTimeInMillis(m);
        } else if (!beCivil && cType != CalculationType.ISLAMIC) {
            // The fields of the calendar will become invalid, because the calendar
            // rules are different
            long m = getTimeInMillis();
            cType = CalculationType.ISLAMIC;
            algorithm = ISLAMIC_ALGORITHM;
            clear();
            setTimeInMillis(m);
        }
        civil = algorithm.isCivil();
    }

    /**
     * Returns <code>true</code> if this object is using the fixed-cycle civil calendar, or <code>
     * false</code> if using the religious, astronomical calendar.
     *
     * @stable ICU 2.8
     * @discouraged ICU 57 use getCalculationType() instead
     */
    public boolean isCivil() {
        return algorithm.isCivil();
    }

    // -------------------------------------------------------------------------
    // Minimum / Maximum access functions
    // -------------------------------------------------------------------------

    // Note: Current IslamicCalendar implementation does not work
    // well with negative years.

    private static final int LIMITS[][] = {
        // Minimum  Greatest     Least   Maximum
        //           Minimum   Maximum
        {0, 0, 0, 0}, // ERA
        {1, 1, 5000000, 5000000}, // YEAR
        {0, 0, 11, 11}, // MONTH
        {1, 1, 50, 51}, // WEEK_OF_YEAR
        {
            /*                                   */
        }, // WEEK_OF_MONTH
        {1, 1, 29, 30}, // DAY_OF_MONTH
        {1, 1, 354, 355}, // DAY_OF_YEAR
        {
            /*                                   */
        }, // DAY_OF_WEEK
        {-1, -1, 5, 5}, // DAY_OF_WEEK_IN_MONTH
        {
            /*                                   */
        }, // AM_PM
        {
            /*                                   */
        }, // HOUR
        {
            /*                                   */
        }, // HOUR_OF_DAY
        {
            /*                                   */
        }, // MINUTE
        {
            /*                                   */
        }, // SECOND
        {
            /*                                   */
        }, // MILLISECOND
        {
            /*                                   */
        }, // ZONE_OFFSET
        {
            /*                                   */
        }, // DST_OFFSET
        {1, 1, 5000000, 5000000}, // YEAR_WOY
        {
            /*                                   */
        }, // DOW_LOCAL
        {1, 1, 5000000, 5000000}, // EXTENDED_YEAR
        {
            /*                                   */
        }, // JULIAN_DAY
        {
            /*                                   */
        }, // MILLISECONDS_IN_DAY
        {
            /*                                   */
        }, // IS_LEAP_MONTH
        {0, 0, 11, 11}, // ORDINAL_MONTH
    };

    /*
     * bit map array where a bit turned on represents a month with 30 days.
     */
    private static final int[] UMALQURA_MONTHLENGTH = {
        // * 1300 -1302 */ "1010 1010 1010", "1101 0101 0100", "1110 1100 1001",
        0x0AAA,
        0x0D54,
        0x0EC9,
        // * 1303 -1307 */ "0110 1101 0100", "0110 1110 1010", "0011 0110 1100", "1010 1010 1101",
        // "0101 0101 0101",
        0x06D4,
        0x06EA,
        0x036C,
        0x0AAD,
        0x0555,
        // * 1308 -1312 */ "0110 1010 1001", "0111 1001 0010", "1011 1010 1001", "0101 1101 0100",
        // "1010 1101 1010",
        0x06A9,
        0x0792,
        0x0BA9,
        0x05D4,
        0x0ADA,
        // * 1313 -1317 */ "0101 0101 1100", "1101 0010 1101", "0110 1001 0101", "0111 0100 1010",
        // "1011 0101 0100",
        0x055C,
        0x0D2D,
        0x0695,
        0x074A,
        0x0B54,
        // * 1318 -1322 */ "1011 0110 1010", "0101 1010 1101", "0100 1010 1110", "1010 0100 1111",
        // "0101 0001 0111",
        0x0B6A,
        0x05AD,
        0x04AE,
        0x0A4F,
        0x0517,
        // * 1323 -1327 */ "0110 1000 1011", "0110 1010 0101", "1010 1101 0101", "0010 1101 0110",
        // "1001 0101 1011",
        0x068B,
        0x06A5,
        0x0AD5,
        0x02D6,
        0x095B,
        // * 1328 -1332 */ "0100 1001 1101", "1010 0100 1101", "1101 0010 0110", "1101 1001 0101",
        // "0101 1010 1100",
        0x049D,
        0x0A4D,
        0x0D26,
        0x0D95,
        0x05AC,
        // * 1333 -1337 */ "1001 1011 0110", "0010 1011 1010", "1010 0101 1011", "0101 0010 1011",
        // "1010 1001 0101",
        0x09B6,
        0x02BA,
        0x0A5B,
        0x052B,
        0x0A95,
        // * 1338 -1342 */ "0110 1100 1010", "1010 1110 1001", "0010 1111 0100", "1001 0111 0110",
        // "0010 1011 0110",
        0x06CA,
        0x0AE9,
        0x02F4,
        0x0976,
        0x02B6,
        // * 1343 -1347 */ "1001 0101 0110", "1010 1100 1010", "1011 1010 0100", "1011 1101 0010",
        // "0101 1101 1001",
        0x0956,
        0x0ACA,
        0x0BA4,
        0x0BD2,
        0x05D9,
        // * 1348 -1352 */ "0010 1101 1100", "1001 0110 1101", "0101 0100 1101", "1010 1010 0101",
        // "1011 0101 0010",
        0x02DC,
        0x096D,
        0x054D,
        0x0AA5,
        0x0B52,
        // * 1353 -1357 */ "1011 1010 0101", "0101 1011 0100", "1001 1011 0110", "0101 0101 0111",
        // "0010 1001 0111",
        0x0BA5,
        0x05B4,
        0x09B6,
        0x0557,
        0x0297,
        // * 1358 -1362 */ "0101 0100 1011", "0110 1010 0011", "0111 0101 0010", "1011 0110 0101",
        // "0101 0110 1010",
        0x054B,
        0x06A3,
        0x0752,
        0x0B65,
        0x056A,
        // * 1363 -1367 */ "1010 1010 1011", "0101 0010 1011", "1100 1001 0101", "1101 0100 1010",
        // "1101 1010 0101",
        0x0AAB,
        0x052B,
        0x0C95,
        0x0D4A,
        0x0DA5,
        // * 1368 -1372 */ "0101 1100 1010", "1010 1101 0110", "1001 0101 0111", "0100 1010 1011",
        // "1001 0100 1011",
        0x05CA,
        0x0AD6,
        0x0957,
        0x04AB,
        0x094B,
        // * 1373 -1377 */ "1010 1010 0101", "1011 0101 0010", "1011 0110 1010", "0101 0111 0101",
        // "0010 0111 0110",
        0x0AA5,
        0x0B52,
        0x0B6A,
        0x0575,
        0x0276,
        // * 1378 -1382 */ "1000 1011 0111", "0100 0101 1011", "0101 0101 0101", "0101 1010 1001",
        // "0101 1011 0100",
        0x08B7,
        0x045B,
        0x0555,
        0x05A9,
        0x05B4,
        // * 1383 -1387 */ "1001 1101 1010", "0100 1101 1101", "0010 0110 1110", "1001 0011 0110",
        // "1010 1010 1010",
        0x09DA,
        0x04DD,
        0x026E,
        0x0936,
        0x0AAA,
        // * 1388 -1392 */ "1101 0101 0100", "1101 1011 0010", "0101 1101 0101", "0010 1101 1010",
        // "1001 0101 1011",
        0x0D54,
        0x0DB2,
        0x05D5,
        0x02DA,
        0x095B,
        // * 1393 -1397 */ "0100 1010 1011", "1010 0101 0101", "1011 0100 1001", "1011 0110 0100",
        // "1011 0111 0001",
        0x04AB,
        0x0A55,
        0x0B49,
        0x0B64,
        0x0B71,
        // * 1398 -1402 */ "0101 1011 0100", "1010 1011 0101", "1010 0101 0101", "1101 0010 0101",
        // "1110 1001 0010",
        0x05B4,
        0x0AB5,
        0x0A55,
        0x0D25,
        0x0E92,
        // * 1403 -1407 */ "1110 1100 1001", "0110 1101 0100", "1010 1110 1001", "1001 0110 1011",
        // "0100 1010 1011",
        0x0EC9,
        0x06D4,
        0x0AE9,
        0x096B,
        0x04AB,
        // * 1408 -1412 */ "1010 1001 0011", "1101 0100 1001", "1101 1010 0100", "1101 1011 0010",
        // "1010 1011 1001",
        0x0A93,
        0x0D49,
        0x0DA4,
        0x0DB2,
        0x0AB9,
        // * 1413 -1417 */ "0100 1011 1010", "1010 0101 1011", "0101 0010 1011", "1010 1001 0101",
        // "1011 0010 1010",
        0x04BA,
        0x0A5B,
        0x052B,
        0x0A95,
        0x0B2A,
        // * 1418 -1422 */ "1011 0101 0101", "0101 0101 1100", "0100 1011 1101", "0010 0011 1101",
        // "1001 0001 1101",
        0x0B55,
        0x055C,
        0x04BD,
        0x023D,
        0x091D,
        // * 1423 -1427 */ "1010 1001 0101", "1011 0100 1010", "1011 0101 1010", "0101 0110 1101",
        // "0010 1011 0110",
        0x0A95,
        0x0B4A,
        0x0B5A,
        0x056D,
        0x02B6,
        // * 1428 -1432 */ "1001 0011 1011", "0100 1001 1011", "0110 0101 0101", "0110 1010 1001",
        // "0111 0101 0100",
        0x093B,
        0x049B,
        0x0655,
        0x06A9,
        0x0754,
        // * 1433 -1437 */ "1011 0110 1010", "0101 0110 1100", "1010 1010 1101", "0101 0101 0101",
        // "1011 0010 1001",
        0x0B6A,
        0x056C,
        0x0AAD,
        0x0555,
        0x0B29,
        // * 1438 -1442 */ "1011 1001 0010", "1011 1010 1001", "0101 1101 0100", "1010 1101 1010",
        // "0101 0101 1010",
        0x0B92,
        0x0BA9,
        0x05D4,
        0x0ADA,
        0x055A,
        // * 1443 -1447 */ "1010 1010 1011", "0101 1001 0101", "0111 0100 1001", "0111 0110 0100",
        // "1011 1010 1010",
        0x0AAB,
        0x0595,
        0x0749,
        0x0764,
        0x0BAA,
        // * 1448 -1452 */ "0101 1011 0101", "0010 1011 0110", "1010 0101 0110", "1110 0100 1101",
        // "1011 0010 0101",
        0x05B5,
        0x02B6,
        0x0A56,
        0x0E4D,
        0x0B25,
        // * 1453 -1457 */ "1011 0101 0010", "1011 0110 1010", "0101 1010 1101", "0010 1010 1110",
        // "1001 0010 1111",
        0x0B52,
        0x0B6A,
        0x05AD,
        0x02AE,
        0x092F,
        // * 1458 -1462 */ "0100 1001 0111", "0110 0100 1011", "0110 1010 0101", "0110 1010 1100",
        // "1010 1101 0110",
        0x0497,
        0x064B,
        0x06A5,
        0x06AC,
        0x0AD6,
        // * 1463 -1467 */ "0101 0101 1101", "0100 1001 1101", "1010 0100 1101", "1101 0001 0110",
        // "1101 1001 0101",
        0x055D,
        0x049D,
        0x0A4D,
        0x0D16,
        0x0D95,
        // * 1468 -1472 */ "0101 1010 1010", "0101 1011 0101", "0010 1101 1010", "1001 0101 1011",
        // "0100 1010 1101",
        0x05AA,
        0x05B5,
        0x02DA,
        0x095B,
        0x04AD,
        // * 1473 -1477 */ "0101 1001 0101", "0110 1100 1010", "0110 1110 0100", "1010 1110 1010",
        // "0100 1111 0101",
        0x0595,
        0x06CA,
        0x06E4,
        0x0AEA,
        0x04F5,
        // * 1478 -1482 */ "0010 1011 0110", "1001 0101 0110", "1010 1010 1010", "1011 0101 0100",
        // "1011 1101 0010",
        0x02B6,
        0x0956,
        0x0AAA,
        0x0B54,
        0x0BD2,
        // * 1483 -1487 */ "0101 1101 1001", "0010 1110 1010", "1001 0110 1101", "0100 1010 1101",
        // "1010 1001 0101",
        0x05D9,
        0x02EA,
        0x096D,
        0x04AD,
        0x0A95,
        // * 1488 -1492 */ "1011 0100 1010", "1011 1010 0101", "0101 1011 0010", "1001 1011 0101",
        // "0100 1101 0110",
        0x0B4A,
        0x0BA5,
        0x05B2,
        0x09B5,
        0x04D6,
        // * 1493 -1497 */ "1010 1001 0111", "0101 0100 0111", "0110 1001 0011", "0111 0100 1001",
        // "1011 0101 0101",
        0x0A97,
        0x0547,
        0x0693,
        0x0749,
        0x0B55,
        // * 1498 -1508 */ "0101 0110 1010", "1010 0110 1011", "0101 0010 1011", "1010 1000 1011",
        // "1101 0100 0110", "1101 1010 0011", "0101 1100 1010", "1010 1101 0110", "0100 1101 1011",
        // "0010 0110 1011", "1001 0100 1011",
        0x056A,
        0x0A6B,
        0x052B,
        0x0A8B,
        0x0D46,
        0x0DA3,
        0x05CA,
        0x0AD6,
        0x04DB,
        0x026B,
        0x094B,
        // * 1509 -1519 */ "1010 1010 0101", "1011 0101 0010", "1011 0110 1001", "0101 0111 0101",
        // "0001 0111 0110", "1000 1011 0111", "0010 0101 1011", "0101 0010 1011", "0101 0110 0101",
        // "0101 1011 0100", "1001 1101 1010",
        0x0AA5,
        0x0B52,
        0x0B69,
        0x0575,
        0x0176,
        0x08B7,
        0x025B,
        0x052B,
        0x0565,
        0x05B4,
        0x09DA,
        // * 1520 -1530 */ "0100 1110 1101", "0001 0110 1101", "1000 1011 0110", "1010 1010 0110",
        // "1101 0101 0010", "1101 1010 1001", "0101 1101 0100", "1010 1101 1010", "1001 0101 1011",
        // "0100 1010 1011", "0110 0101 0011",
        0x04ED,
        0x016D,
        0x08B6,
        0x0AA6,
        0x0D52,
        0x0DA9,
        0x05D4,
        0x0ADA,
        0x095B,
        0x04AB,
        0x0653,
        // * 1531 -1541 */ "0111 0010 1001", "0111 0110 0010", "1011 1010 1001", "0101 1011 0010",
        // "1010 1011 0101", "0101 0101 0101", "1011 0010 0101", "1101 1001 0010", "1110 1100 1001",
        // "0110 1101 0010", "1010 1110 1001",
        0x0729,
        0x0762,
        0x0BA9,
        0x05B2,
        0x0AB5,
        0x0555,
        0x0B25,
        0x0D92,
        0x0EC9,
        0x06D2,
        0x0AE9,
        // * 1542 -1552 */ "0101 0110 1011", "0100 1010 1011", "1010 0101 0101", "1101 0010 1001",
        // "1101 0101 0100", "1101 1010 1010", "1001 1011 0101", "0100 1011 1010", "1010 0011 1011",
        // "0100 1001 1011", "1010 0100 1101",
        0x056B,
        0x04AB,
        0x0A55,
        0x0D29,
        0x0D54,
        0x0DAA,
        0x09B5,
        0x04BA,
        0x0A3B,
        0x049B,
        0x0A4D,
        // * 1553 -1563 */ "1010 1010 1010", "1010 1101 0101", "0010 1101 1010", "1001 0101 1101",
        // "0100 0101 1110", "1010 0010 1110", "1100 1001 1010", "1101 0101 0101", "0110 1011 0010",
        // "0110 1011 1001", "0100 1011 1010",
        0x0AAA,
        0x0AD5,
        0x02DA,
        0x095D,
        0x045E,
        0x0A2E,
        0x0C9A,
        0x0D55,
        0x06B2,
        0x06B9,
        0x04BA,
        // * 1564 -1574 */ "1010 0101 1101", "0101 0010 1101", "1010 1001 0101", "1011 0101 0010",
        // "1011 1010 1000", "1011 1011 0100", "0101 1011 1001", "0010 1101 1010", "1001 0101 1010",
        // "1011 0100 1010", "1101 1010 0100",
        0x0A5D,
        0x052D,
        0x0A95,
        0x0B52,
        0x0BA8,
        0x0BB4,
        0x05B9,
        0x02DA,
        0x095A,
        0x0B4A,
        0x0DA4,
        // * 1575 -1585 */ "1110 1101 0001", "0110 1110 1000", "1011 0110 1010", "0101 0110 1101",
        // "0101 0011 0101", "0110 1001 0101", "1101 0100 1010", "1101 1010 1000", "1101 1101 0100",
        // "0110 1101 1010", "0101 0101 1011",
        0x0ED1,
        0x06E8,
        0x0B6A,
        0x056D,
        0x0535,
        0x0695,
        0x0D4A,
        0x0DA8,
        0x0DD4,
        0x06DA,
        0x055B,
        // * 1586 -1596 */ "0010 1001 1101", "0110 0010 1011", "1011 0001 0101", "1011 0100 1010",
        // "1011 1001 0101", "0101 1010 1010", "1010 1010 1110", "1001 0010 1110", "1100 1000 1111",
        // "0101 0010 0111", "0110 1001 0101",
        0x029D,
        0x062B,
        0x0B15,
        0x0B4A,
        0x0B95,
        0x05AA,
        0x0AAE,
        0x092E,
        0x0C8F,
        0x0527,
        0x0695,
        // * 1597 -1600 */ "0110 1010 1010", "1010 1101 0110", "0101 0101 1101", "0010 1001 1101",
        // };
        0x06AA,
        0x0AD6,
        0x055D,
        0x029D
    };

    private static final int UMALQURA_YEAR_START = 1300;
    private static final int UMALQURA_YEAR_END = 1600;

    /**
     * @stable ICU 2.8
     */
    @Override
    protected int handleGetLimit(int field, int limitType) {
        return LIMITS[field][limitType];
    }

    // -------------------------------------------------------------------------
    // Assorted calculation utilities
    //

    // we could compress this down more if we need to
    private static final byte[] UMALQURA_YEAR_START_ESTIMATE_FIX = {
        0, 0, -1, 0, -1, 0, 0, 0, 0, 0, // 1300..
        -1, 0, 0, 0, 0, 0, 0, 0, -1, 0, // 1310..
        1, 0, 1, 1, 0, 0, 0, 0, 1, 0, // 1320..
        0, 0, 0, 0, 0, 0, 1, 0, 0, 0, // 1330..
        0, 0, 1, 0, 0, -1, -1, 0, 0, 0, // 1340..
        1, 0, 0, -1, 0, 0, 0, 1, 1, 0, // 1350..
        0, 0, 0, 0, 0, 0, 0, -1, 0, 0, // 1360..
        0, 1, 1, 0, 0, -1, 0, 1, 0, 1, // 1370..
        1, 0, 0, -1, 0, 1, 0, 0, 0, -1, // 1380..
        0, 1, 0, 1, 0, 0, 0, -1, 0, 0, // 1390..
        0, 0, -1, -1, 0, -1, 0, 1, 0, 0, // 1400..
        0, -1, 0, 0, 0, 1, 0, 0, 0, 0, // 1410..
        0, 1, 0, 0, -1, -1, 0, 0, 0, 1, // 1420..
        0, 0, -1, -1, 0, -1, 0, 0, -1, -1, // 1430..
        0, -1, 0, -1, 0, 0, -1, -1, 0, 0, // 1440..
        0, 0, 0, 0, -1, 0, 1, 0, 1, 1, // 1450..
        0, 0, -1, 0, 1, 0, 0, 0, 0, 0, // 1460..
        1, 0, 1, 0, 0, 0, -1, 0, 1, 0, // 1470..
        0, -1, -1, 0, 0, 0, 1, 0, 0, 0, // 1480..
        0, 0, 0, 0, 1, 0, 0, 0, 0, 0, // 1490..
        1, 0, 0, -1, 0, 0, 0, 1, 1, 0, // 1500..
        0, -1, 0, 1, 0, 1, 1, 0, 0, 0, // 1510..
        0, 1, 0, 0, 0, -1, 0, 0, 0, 1, // 1520..
        0, 0, 0, -1, 0, 0, 0, 0, 0, -1, // 1530..
        0, -1, 0, 1, 0, 0, 0, -1, 0, 1, // 1540..
        0, 1, 0, 0, 0, 0, 0, 1, 0, 0, // 1550..
        -1, 0, 0, 0, 0, 1, 0, 0, 0, -1, // 1560..
        0, 0, 0, 0, -1, -1, 0, -1, 0, 1, // 1570..
        0, 0, -1, -1, 0, 0, 1, 1, 0, 0, // 1580..
        -1, 0, 0, 0, 0, 1, 0, 0, 0, 0, // 1590..
        1 // 1600
    };

    // Unused code - Alan 2003-05
    //    /**
    //     * Find the day of the week for a given day
    //     *
    //     * @param day   The # of days since the start of the Islamic calendar.
    //     */
    //    // private and uncalled, perhaps not used yet?
    //    private static final int absoluteDayToDayOfWeek(long day)
    //    {
    //        // Calculate the day of the week.
    //        // This relies on the fact that the epoch was a Thursday.
    //        int dayOfWeek = (int)(day + THURSDAY) % 7 + SUNDAY;
    //        if (dayOfWeek < 0) {
    //            dayOfWeek += 7;
    //        }
    //        return dayOfWeek;
    //    }

    /** Determine whether a year is a leap year in the Islamic civil calendar */
    private static final boolean civilLeapYear(int year) {
        return (14 + 11 * year) % 30 < 11;
    }

    /**
     * Return the day # on which the given year starts. Days are counted from the Hijri epoch,
     * origin 0.
     */
    private long yearStart(int year) {
        return algorithm.yearStart(year);
    }

    /**
     * Find the day number on which a particular month of the true/lunar Islamic calendar starts.
     *
     * @param month The month in question, origin 0 from the Hijri epoch
     * @return The day number on which the given month starts.
     */
    private static final long trueMonthStart(long month) {
        long start = cache.get(month);

        if (start == CalendarCache.EMPTY) {
            // Make a guess at when the month started, using the average length
            long origin =
                    HIJRA_MILLIS
                            + (long) Math.floor(month * CalendarAstronomer.SYNODIC_MONTH) * ONE_DAY;

            double age = moonAge(origin);

            if (moonAge(origin) >= 0) {
                // The month has already started
                do {
                    origin -= ONE_DAY;
                    age = moonAge(origin);
                } while (age >= 0);
            } else {
                // Preceding month has not ended yet.
                do {
                    origin += ONE_DAY;
                    age = moonAge(origin);
                } while (age < 0);
            }

            start = (origin - HIJRA_MILLIS) / ONE_DAY + 1;

            cache.put(month, start);
        }
        return start;
    }

    /**
     * Return the "age" of the moon at the given time; this is the difference in ecliptic latitude
     * between the moon and the sun. This method simply calls CalendarAstronomer.moonAge, converts
     * to degrees, and adjusts the resultto be in the range [-180, 180].
     *
     * @param time The time at which the moon's age is desired, in millis since 1/1/1970.
     */
    static final double moonAge(long time) {
        double age = (new CalendarAstronomer(time)).getMoonAge();
        // Convert to degrees and normalize...
        age = age * 180 / Math.PI;
        if (age > 180) {
            age = age - 360;
        }

        return age;
    }

    // -------------------------------------------------------------------------
    // Internal data....
    //

    private static CalendarCache cache = new CalendarCache();

    /**
     * <code>true</code> if this object uses the fixed-cycle Islamic civil calendar, and <code>false
     * </code> if it approximates the true religious calendar using astronomical calculations for
     * the time of the new moon.
     *
     * @serial
     */
    private boolean civil = true;

    /**
     * determines the type of calculation to use for this instance
     *
     * @serial
     * @stable ICU 52
     */
    private CalculationType cType = CalculationType.ISLAMIC_CIVIL;

    private transient Algorithm algorithm = CIVIL_ALGORITHM;

    // ----------------------------------------------------------------------
    // Calendar framework
    // ----------------------------------------------------------------------

    /**
     * Return the length (in days) of the given month.
     *
     * @param extendedYear The hijri year
     * @param month The hijri month, 0-based
     * @stable ICU 2.8
     */
    @Override
    protected int handleGetMonthLength(int extendedYear, int month) {
        return algorithm.monthLength(extendedYear, month);
    }

    /**
     * Return the number of days in the given Islamic year
     *
     * @stable ICU 2.8
     */
    @Override
    protected int handleGetYearLength(int extendedYear) {
        return algorithm.yearLength(extendedYear);
    }

    // -------------------------------------------------------------------------
    // Functions for converting from field values to milliseconds....
    // -------------------------------------------------------------------------

    // Return JD of start of given month/year
    // Calendar says:
    // Get the Julian day of the day BEFORE the start of this year.
    // If useMonth is true, get the day before the start of the month.
    // Hence the -1
    /**
     * @stable ICU 2.8
     */
    @Override
    protected int handleComputeMonthStart(int eyear, int month, boolean useMonth) {
        return (int) (algorithm.monthStart(eyear, month) + algorithm.epoch() - 1);
    }

    // -------------------------------------------------------------------------
    // Functions for converting from milliseconds to field values
    // -------------------------------------------------------------------------

    /**
     * @stable ICU 2.8
     */
    @Override
    protected int handleGetExtendedYear() {
        int year;
        if (newerField(EXTENDED_YEAR, YEAR) == EXTENDED_YEAR) {
            year = internalGet(EXTENDED_YEAR, 1); // Default to year 1
        } else {
            year = internalGet(YEAR, 1); // Default to year 1
        }
        return year;
    }

    /**
     * Override Calendar to compute several fields specific to the Islamic calendar system. These
     * are:
     *
     * <ul>
     *   <li>ERA
     *   <li>YEAR
     *   <li>MONTH
     *   <li>DAY_OF_MONTH
     *   <li>DAY_OF_YEAR
     *   <li>EXTENDED_YEAR
     * </ul>
     *
     * The DAY_OF_WEEK and DOW_LOCAL fields are already set when this method is called. The
     * getGregorianXxx() methods return Gregorian calendar equivalents for the given Julian day.
     *
     * @stable ICU 2.8
     */
    @Override
    protected void handleComputeFields(int julianDay) {
        algorithm.compute(
                julianDay,
                internalGetTimeInMillis(),
                year -> {
                    internalSet(ERA, 0);
                    internalSet(YEAR, year);
                    internalSet(EXTENDED_YEAR, year);
                },
                month -> {
                    internalSet(MONTH, month);
                    internalSet(ORDINAL_MONTH, month);
                },
                dayOfMonth -> {
                    internalSet(DAY_OF_MONTH, dayOfMonth);
                },
                dayOfYear -> {
                    internalSet(DAY_OF_YEAR, dayOfYear);
                });
    }

    /**
     * enumeration of available calendar calculation types
     *
     * @stable ICU 52
     */
    public enum CalculationType {
        /**
         * Religious calendar (astronomical simulation)
         *
         * @stable ICU 52
         */
        ISLAMIC("islamic"),
        /**
         * Tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29]) algorithm with civil (Friday)
         * epoch.
         *
         * @stable ICU 52
         */
        ISLAMIC_CIVIL("islamic-civil"),
        /**
         * Umm al-Qura calendar
         *
         * @stable ICU 52
         */
        ISLAMIC_UMALQURA("islamic-umalqura"),
        /**
         * Tabular (intercalary years [2,5,7,10,13,16,18,21,24,26,29]) algorithm with astronomical
         * (Thursday) epoch.
         *
         * @stable ICU 52
         */
        ISLAMIC_TBLA("islamic-tbla");

        private String bcpType;

        CalculationType(String bcpType) {
            this.bcpType = bcpType;
        }

        String bcpType() {
            return bcpType;
        }
    };

    /**
     * sets the calculation type for this calendar.
     *
     * @stable ICU 55
     */
    public void setCalculationType(CalculationType type) {
        cType = type;
        switch (cType) {
            case ISLAMIC_UMALQURA:
                algorithm = UMALQURA_ALGORITHM;
                break;
            case ISLAMIC:
                algorithm = ISLAMIC_ALGORITHM;
                break;
            case ISLAMIC_TBLA:
                algorithm = TBLA_ALGORITHM;
                break;
            case ISLAMIC_CIVIL:
            default:
                algorithm = CIVIL_ALGORITHM;
                break;
        }
        civil = algorithm.isCivil();
    }

    /** utility function for getRelatedYear */
    private static final int gregoYearFromIslamicStart(int year) {
        // ad hoc conversion, improve under #10752
        // rough est for now, ok for grego 1846-2138,
        // otherwise occasionally wrong (for 3% of years)
        int cycle, offset, shift = 0;
        if (year >= 1397) {
            cycle = (year - 1397) / 67;
            offset = (year - 1397) % 67;
            shift = 2 * cycle + ((offset >= 33) ? 1 : 0);
        } else {
            cycle = (year - 1396) / 67 - 1;
            offset = -(year - 1396) % 67;
            shift = 2 * cycle + ((offset <= 33) ? 1 : 0);
        }
        return year + 579 - shift;
    }

    /**
     * @internal
     * @deprecated This API is ICU internal only.
     */
    @Override
    @Deprecated
    public final int getRelatedYear() {
        return gregoYearFromIslamicStart(get(EXTENDED_YEAR));
    }

    /** utility function for setRelatedYear */
    private static int firstIslamicStartYearFromGrego(int year) {
        // ad hoc conversion, improve under #10752
        // rough est for now, ok for grego 1846-2138,
        // otherwise occasionally wrong (for 3% of years)
        int cycle, offset, shift = 0;
        if (year >= 1977) {
            cycle = (year - 1977) / 65;
            offset = (year - 1977) % 65;
            shift = 2 * cycle + ((offset >= 32) ? 1 : 0);
        } else {
            cycle = (year - 1976) / 65 - 1;
            offset = -(year - 1976) % 65;
            shift = 2 * cycle + ((offset <= 32) ? 1 : 0);
        }
        return year - 579 + shift;
    }

    /**
     * @internal
     * @deprecated This API is ICU internal only.
     */
    @Override
    @Deprecated
    public final void setRelatedYear(int year) {
        set(EXTENDED_YEAR, firstIslamicStartYearFromGrego(year));
    }

    /**
     * gets the calculation type for this calendar.
     *
     * @stable ICU 55
     */
    public CalculationType getCalculationType() {
        return algorithm.getType();
    }

    /** set type based on locale */
    private void setCalcTypeForLocale(ULocale locale) {
        String localeCalType = CalendarUtil.getCalendarType(locale);
        if ("islamic-civil".equals(localeCalType))
            setCalculationType(CalculationType.ISLAMIC_CIVIL);
        else if ("islamic-umalqura".equals(localeCalType))
            setCalculationType(CalculationType.ISLAMIC_UMALQURA);
        else if ("islamic-tbla".equals(localeCalType))
            setCalculationType(CalculationType.ISLAMIC_TBLA);
        else if (localeCalType.startsWith("islamic"))
            setCalculationType(
                    CalculationType.ISLAMIC); // needs to be last so it's always the default if it's
        // islamic-something-unhandled
        else
            setCalculationType(
                    CalculationType.ISLAMIC_CIVIL); // default for any non-islamic calendar locale
    }

    /**
     * {@inheritDoc}
     *
     * @stable ICU 3.8
     */
    @Override
    public String getType() {
        return algorithm.getType().bcpType();
    }

    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();
        if (cType == null) {
            // The serialized data was created by an ICU version before CalculationType
            // was introduced.
            cType = civil ? CalculationType.ISLAMIC_CIVIL : CalculationType.ISLAMIC;
        }
        setCalculationType(cType);
    }

    // -------------------------------------------------------------------------
    // Temporal Calendar API.
    // -------------------------------------------------------------------------
    /**
     * {@icu} Returns true if the date is in a leap year. Recalculate the current time field values
     * if the time value has been changed by a call to setTime(). This method is semantically const,
     * but may alter the object in memory. A "leap year" is a year that contains more days than
     * other years (for solar or lunar calendars) or more months than other years (for lunisolar
     * calendars like Hebrew or Chinese), as defined in the ECMAScript Temporal proposal.
     *
     * @return true if the date in the fields is in a Temporal proposal defined leap year. False
     *     otherwise.
     * @stable ICU 74
     */
    @Override
    public boolean inTemporalLeapYear() {
        return getActualMaximum(DAY_OF_YEAR) == 355;
    }

    // -------------------------------------------------------------------------
    // End of Temporal Calendar API
    // -------------------------------------------------------------------------

    /*
    private static CalendarFactory factory;
    public static CalendarFactory factory() {
        if (factory == null) {
            factory = new CalendarFactory() {
                public Calendar create(TimeZone tz, ULocale loc) {
                    return new IslamicCalendar(tz, loc);
                }

                public String factoryName() {
                    return "Islamic";
                }
            };
        }
        return factory;
    }
    */
}