Package-level declarations
Types
The HebrewDateFormatter class formats a JewishDate.
A class representing a Hebrew local date. Hebrew analog to kotlinx.datetime.LocalDate Although the Hebrew year actually starts in HebrewMonth.TISHREI, the choice was made to assign HebrewMonth.NISSAN with a value of 1. This may be because the year is colloquially said to start in Nissan (in accordance with the opinion Maseches Rosh Hashana (TODO include source) that the world was created in Nissan). Note: this class considers the Gregorian calendar to start at year 0, in accordance with ISO-8601.
The JewishCalendar extends the JewishDate class and adds calendar methods.
The JewishDate is the base calendar class, that supports maintenance of a LocalDateTime instance along with the corresponding Jewish date. This class can use the standard Java (TODO change for kotlin) Date and Calendar classes for setting and maintaining the dates, but it does not subclass these classes or use them internally in any calculations. This class also does not have a concept of a time (which the Date class does). Please note that the calendar does not currently support dates prior to 1/1/1 Gregorian. Also keep in mind that the Gregorian calendar started on October 15, 1582, so any calculations prior to that are suspect (at least from a Gregorian perspective). While 1/1/1 Gregorian and forward are technically supported, any calculations prior to Hillel II's (Hakatan's) calendar (4119 in the Jewish Calendar / 359 CE Julian as recorded by Rav Hai Gaon) would be just an approximation.
Tefila Rules is a utility class that covers the various halachos and minhagim regarding changes to daily tefila / prayers, based on the Jewish calendar. This is mostly useful for use in developing siddur type applications, but it is also valuable for shul calendars that set tefila times based on if tachanun is recited that day. There are many settings in this class to cover the vast majority of minhagim, but there are likely some not covered here. The source for many of the chasidishe minhagim can be found in the Minhag Yisrael Torah on Orach Chaim 131. Dates used in specific communities such as specific yahrzeits or a holidays like Purim Mezhbizh (Medzhybizh) celebrated on 11 Teves or Purim Saragossa celebrated on the (17th or) 18th of Shevat are not (and likely will not be) supported by this class.
This class calculates the Talmud Yerusalmi Daf Yomi page (Daf) for the a given date.
This class calculates the Daf Yomi Bavli page (daf) for a given date. To calculate Daf Yomi Yerushalmi use the YerushalmiYomiCalculator. The library may cover Mishna Yomi etc. at some point in the future.