orrery-calendars/me.kozakov.orrery.calendars.hijri

Package-level declarations

Types

data class HijriDate(val year: Int, val month: Int, val day: Int, val variant: HijriVariant = HijriVariant.UmmAlQura)

A date in the Hijri (Islamic lunar) calendar. month is 1 (Muharram) .. 12 (Dhu al-Hijjah). Construction checks the month and that day is 1..30; toLocalDate also checks the day against the month length of variant.

HijriDayInfoProvider

class HijriDayInfoProvider(variant: HijriVariant = HijriVariant.UmmAlQura, strings: HijriStrings = HijriStrings.English) : DayInfoProvider

DayInfoProvider that labels each day with its Hijri date: the month name on the first day of a month, the day number otherwise. DayInfo.payload is the HijriDate, DayInfo.tags is ["hijri"] and DayInfo.priority is DayInfoPriority.SECONDARY, so a holiday provider combined with + wins the label.

HijriStrings

class HijriStrings(val monthNames: List<String>, val digits: String = "0123456789")

Labels used by HijriDayInfoProvider: monthNames holds the 12 month names from Muharram, shown on the first day of each month; digits holds the ten digits 0..9 used for the other days' numbers.

HijriVariant

enum HijriVariant : Enum<HijriVariant>

Rule set used to convert between Gregorian and Hijri dates.

Functions

monthLength

fun HijriDate.monthLength(): Int

Number of days (29 or 30) in this date's month.

toHijriDate

fun LocalDate.toHijriDate(variant: HijriVariant = HijriVariant.UmmAlQura): HijriDate

Converts this date to the Hijri calendar.

toLocalDate

fun HijriDate.toLocalDate(): LocalDate

Converts this Hijri date to a Gregorian LocalDate.