|
1 | 1 | /** |
2 | | - * This package contain classes that represent a <a href="https://en.wikipedia.org/wiki/Hebrew_calendar">Jewish Date/Calendar</a>, |
| 2 | + * This package contains classes that represent a <a href="https://en.wikipedia.org/wiki/Hebrew_calendar">Jewish Date/Calendar</a>, |
3 | 3 | * and allows conversion between {@link JewishDate Jewish} and {@link java.time.LocalDate Gregorian dates}. The main calendar |
4 | 4 | * classes {@link JewishCalendar} and {@link JewishDate} are based on <a href="https://www.linkedin.com/in/avromf/">Avrom Finkelstein's</a> code from 2002, |
5 | 5 | * refactored to fit the Zmanim API. The parsha and season-based <em>tefila</em> change code was ported by Y. Paritcher from his |
6 | 6 | * <a href="https://github.com/yparitcher/libzmanim">libzmanim</a> code. |
7 | | - * |
| 7 | + * |
8 | 8 | * <h2>Design:</h2> |
9 | 9 | * <ul> |
10 | 10 | * <li>{@link JewishDate} is the base class, allowing the maintenance of an instance of a Gregorian date along with the corresponding Jewish date.</li> |
11 | | - * <li>{@link JewishCalendar} extends JewishDate and adds some methods related to the calendar.</li> |
| 11 | + * <li>{@link JewishCalendar} extends JewishDate and adds calendar information: <em>Yamim Tovim</em>, fast days, <em>Rosh Chodesh</em>, |
| 12 | + * <em>Chanukah</em>, the weekly <em>parsha</em> and special <em>parshiyos</em>, the <em>molad</em>, <em>tekufos</em>, |
| 13 | + * <em>Birkas Hachamah</em> and <em>Daf Yomi</em>.</li> |
12 | 14 | * <li>{@link TefilaRules} is a utility class for various calendar based <em>tefila</em> rules.</li> |
13 | | - * <li>{@link HebrewDateFormatter} defines the basics for taking a JewishCalendar and formatting the dates.</li> |
| 15 | + * <li>{@link HebrewDateFormatter} formats dates, <em>Yamim Tovim</em>, <em>parshiyos</em> and numbers, in Hebrew or transliterated, |
| 16 | + * with options such as final-form letters and <em>geresh</em> / <em>gershayim</em>.</li> |
14 | 17 | * <li>{@link YomiCalculator} calculates the {@link Daf} Yomi Bavli for a given JewishCalendar and {@link YerushalmiYomiCalculator} does the same |
15 | 18 | * for Yerushalmi Yomi.</li> |
16 | 19 | * </ul> |
17 | | - * @author © Eliyahu Hershfeld 2011 - 2026 |
| 20 | + * |
| 21 | + * <h2>Settings that change results:</h2> |
| 22 | + * <ul> |
| 23 | + * <li>{@link JewishCalendar#setInIsrael(boolean)}: Israel or diaspora <em>Yom Tov</em> (one or two days) and <em>parshiyos</em>.</li> |
| 24 | + * <li>{@link JewishCalendar#setIsMukafChoma(boolean)}: whether <em>Purim</em> is observed on <em>Shushan Purim</em> (walled cities).</li> |
| 25 | + * <li>{@link JewishCalendar#setUseModernHolidays(boolean)}: whether modern Israeli holidays are included.</li> |
| 26 | + * </ul> |
| 27 | + * Instances are mutable and not thread-safe; use a separate instance per thread. |
| 28 | + * |
| 29 | + * @author © Eliyahu Hershfeld 2011 - 2026 |
18 | 30 | */ |
19 | 31 | package com.kosherjava.zmanim.hebrewcalendar; |
0 commit comments