JewishCalendar (Zmanim API 1.3.0beta-Dec-18-2011)

java.lang.Object
- net.sourceforge.zmanim.hebrewcalendar.JewishDate
- - net.sourceforge.zmanim.hebrewcalendar.JewishCalendar

All Implemented Interfaces:

Cloneable, Comparable<JewishDate>
```
public class JewishCalendar
extends JewishDate
```
The JewishCalendar extends the JewishDate class and adds calendar methods. This open source Java code was originally ported by Avrom Finkelstien from his C++ code. It was refactored to fit the KosherJava Zmanim API with simplification of the code, enhancements and some bug fixing. The methods used to obtain the parsha were derived from the source code of HebCal by Danny Sadinoff and JCal for the Mac by Frank Yellin. Both based their code on routines by Nachum Dershowitz and Edward M. Reingold. The class allows setting whether the parsha and holiday scheme follows the Israel scheme or outside Israel scheme. The default is the outside Israel scheme. TODO: Some do not belong in this class, but here is a partial list of what should still be implemented in some form:
1. Add Isru Chag
2. Add special parshiyos (shekalim, parah, zachor and hachodesh
3. Shabbos Mevarchim
4. Haftorah (various minhagim)
5. Daf Yomi Yerushalmi, Mishna yomis etc)
6. Support showing the upcoming parsha for the middle of the week
Version:

0.0.1

Author:

© Avrom Finkelstien 2002, © Eliyahu Hershfeld 2011

See Also:
Date, Calendar

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CHANUKAH`
`static int`	`CHOL_HAMOED_PESACH`
`static int`	`CHOL_HAMOED_SUCCOS`
`static int`	`EREV_PESACH`
`static int`	`EREV_ROSH_HASHANA`
`static int`	`EREV_SHAVUOS`
`static int`	`EREV_SUCCOS`
`static int`	`EREV_YOM_KIPPUR`
`static int`	`FAST_OF_ESTHER`
`static int`	`FAST_OF_GEDALYAH`
`static int`	`HOSHANA_RABBA`
`static int`	`PESACH`
`static int`	`PESACH_SHENI`
`static int`	`PURIM`
`static int`	`PURIM_KATAN`
`static int`	`ROSH_CHODESH`
`static int`	`ROSH_HASHANA`
`static int`	`SEVENTEEN_OF_TAMMUZ`
`static int`	`SHAVUOS`
`static int`	`SHEMINI_ATZERES`
`static int`	`SHUSHAN_PURIM`
`static int`	`SIMCHAS_TORAH`
`static int`	`SUCCOS`
`static int`	`TENTH_OF_TEVES`
`static int`	`TISHA_BEAV`
`static int`	`TU_BEAV`
`static int`	`TU_BESHVAT`
`static int`	`YOM_HAATZMAUT`
`static int`	`YOM_HASHOAH`
`static int`	`YOM_HAZIKARON`
`static int`	`YOM_KIPPUR`
`static int`	`YOM_YERUSHALAYIM`

Fields inherited from class net.sourceforge.zmanim.hebrewcalendar.JewishDate
ADAR, ADAR_II, AV, CHASERIM, CHESHVAN, ELUL, IYAR, KESIDRAN, KISLEV, NISSAN, SHELAIMIM, SHEVAT, SIVAN, TAMMUZ, TEVES, TISHREI

Constructor Summary

Constructors
Constructor and Description
`JewishCalendar()` Default constructor will set a default date to the current system date.
`JewishCalendar(Calendar calendar)` A constructor that initializes the date to the `Calendar` parameter.
`JewishCalendar(Date date)` A constructor that initializes the date to the `Date` parameter.
`JewishCalendar(int jewishYear, int jewishMonth, int jewishDayOfMonth)` Creates a Jewish date based on a Jewish year, month and day of month.
`JewishCalendar(int jewishYear, int jewishMonth, int jewishDayOfMonth, boolean inIsrael)` Creates a Jewish date based on a Jewish date and whether in Israel

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`Daf`	`getDafYomiBavli()` Returns the Daf Yomi (Bavli) for the date that the calendar is set to.
`int`	`getDayOfChanukah()` Returns the day of Chanukah or -1 if it is not Chanukah.
`int`	`getDayOfOmer()` Returns the int value of the Omer day or -1 if the day is not in the omer
`boolean`	`getInIsrael()` Gets whether Israel parsha and holiday scheme is used or not.
`Date`	`getMoladAsDate()` Returns the molad in Standard Time in Yerushalayim as a Date.
`int`	`getParshaIndex()` Returns a the index of today's parsha(ios) or a -1 if there is none.
`Date`	`getSofZmanKidushLevana15Days()` Returns the latest time of Kiddush Levana calculated as 15 days after the molad.
`Date`	`getSofZmanKidushLevanaBetweenMoldos()` Returns the latest time of Kiddush Levana according to the Maharil's opinion that it is calculated as halfway between molad and molad.
`Date`	`getTchilasZmanKidushLevana3Days()` Returns the earliest time of Kiddush Levana calculated as 3 days after the molad.
`Date`	`getTchilasZmanKidushLevana7Days()` Returns the earliest time of Kiddush Levana calculated as 7 days after the molad as mentioned by the Mechaber.
`int`	`getYomTovIndex()` Returns an index of the Jewish holiday or fast day for the current day, or a null if there is no holiday for this day.
`int`	`hashCode()`
`boolean`	`isChanukah()`
`boolean`	`isCholHamoed()` Returns true if the current day is Chol Hamoed of Pesach or Succos.
`boolean`	`isErevRoshChodesh()` Returns true if the current day is Erev Rosh Chodesh.
`boolean`	`isErevYomTov()` Returns true if the current day is erev Yom Tov.
`boolean`	`isRoshChodesh()` Returns if the day is Rosh Chodesh.
`boolean`	`isTaanis()` Return true if the day is a Taanis (fast day).
`boolean`	`isUseModernHolidays()` Is this calendar set to return modern Israeli national holidays.
`boolean`	`isYomTov()` Returns true if the current day is Yom Tov.
`void`	`setInIsrael(boolean inIsrael)` Sets whether to use Israel parsha and holiday scheme or not.
`void`	`setUseModernHolidays(boolean useModernHolidays)` Seth the calendar to return modern Israeli national holidays.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EREV_PESACH
```
public static final int EREV_PESACH
```
    See Also:
    Constant Field Values
  - PESACH
```
public static final int PESACH
```
    See Also:
    Constant Field Values
  - CHOL_HAMOED_PESACH
```
public static final int CHOL_HAMOED_PESACH
```
    See Also:
    Constant Field Values
  - PESACH_SHENI
```
public static final int PESACH_SHENI
```
    See Also:
    Constant Field Values
  - EREV_SHAVUOS
```
public static final int EREV_SHAVUOS
```
    See Also:
    Constant Field Values
  - SHAVUOS
```
public static final int SHAVUOS
```
    See Also:
    Constant Field Values
  - SEVENTEEN_OF_TAMMUZ
```
public static final int SEVENTEEN_OF_TAMMUZ
```
    See Also:
    Constant Field Values
  - TISHA_BEAV
```
public static final int TISHA_BEAV
```
    See Also:
    Constant Field Values
  - TU_BEAV
```
public static final int TU_BEAV
```
    See Also:
    Constant Field Values
  - EREV_ROSH_HASHANA
```
public static final int EREV_ROSH_HASHANA
```
    See Also:
    Constant Field Values
  - ROSH_HASHANA
```
public static final int ROSH_HASHANA
```
    See Also:
    Constant Field Values
  - FAST_OF_GEDALYAH
```
public static final int FAST_OF_GEDALYAH
```
    See Also:
    Constant Field Values
  - EREV_YOM_KIPPUR
```
public static final int EREV_YOM_KIPPUR
```
    See Also:
    Constant Field Values
  - YOM_KIPPUR
```
public static final int YOM_KIPPUR
```
    See Also:
    Constant Field Values
  - EREV_SUCCOS
```
public static final int EREV_SUCCOS
```
    See Also:
    Constant Field Values
  - SUCCOS
```
public static final int SUCCOS
```
    See Also:
    Constant Field Values
  - CHOL_HAMOED_SUCCOS
```
public static final int CHOL_HAMOED_SUCCOS
```
    See Also:
    Constant Field Values
  - HOSHANA_RABBA
```
public static final int HOSHANA_RABBA
```
    See Also:
    Constant Field Values
  - SHEMINI_ATZERES
```
public static final int SHEMINI_ATZERES
```
    See Also:
    Constant Field Values
  - SIMCHAS_TORAH
```
public static final int SIMCHAS_TORAH
```
    See Also:
    Constant Field Values
  - CHANUKAH
```
public static final int CHANUKAH
```
    See Also:
    Constant Field Values
  - TENTH_OF_TEVES
```
public static final int TENTH_OF_TEVES
```
    See Also:
    Constant Field Values
  - TU_BESHVAT
```
public static final int TU_BESHVAT
```
    See Also:
    Constant Field Values
  - FAST_OF_ESTHER
```
public static final int FAST_OF_ESTHER
```
    See Also:
    Constant Field Values
  - PURIM
```
public static final int PURIM
```
    See Also:
    Constant Field Values
  - SHUSHAN_PURIM
```
public static final int SHUSHAN_PURIM
```
    See Also:
    Constant Field Values
  - PURIM_KATAN
```
public static final int PURIM_KATAN
```
    See Also:
    Constant Field Values
  - ROSH_CHODESH
```
public static final int ROSH_CHODESH
```
    See Also:
    Constant Field Values
  - YOM_HASHOAH
```
public static final int YOM_HASHOAH
```
    See Also:
    Constant Field Values
  - YOM_HAZIKARON
```
public static final int YOM_HAZIKARON
```
    See Also:
    Constant Field Values
  - YOM_HAATZMAUT
```
public static final int YOM_HAATZMAUT
```
    See Also:
    Constant Field Values
  - YOM_YERUSHALAYIM
```
public static final int YOM_YERUSHALAYIM
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JewishCalendar
```
public JewishCalendar()
```
    Default constructor will set a default date to the current system date.
  - JewishCalendar
```
public JewishCalendar(Date date)
```
    A constructor that initializes the date to the Date parameter.
    
    Parameters:
    date - the Date to set the calendar to
  - JewishCalendar
```
public JewishCalendar(Calendar calendar)
```
    A constructor that initializes the date to the Calendar parameter.
    
    Parameters:
    calendar - the Calendar to set the calendar to
  - JewishCalendar
```
public JewishCalendar(int jewishYear,
              int jewishMonth,
              int jewishDayOfMonth)
```
    Creates a Jewish date based on a Jewish year, month and day of month.
    
    Parameters:
    jewishYear - the Jewish year
    jewishMonth - the Jewish month. The method expects a 1 for Nissan ... 12 for Adar and 13 for Adar II. Use the constants JewishDate.NISSAN ... JewishDate.ADAR (or JewishDate.ADAR_II for a leap year Adar II) to avoid any confusion.
    jewishDayOfMonth - the Jewish day of month. If 30 is passed in for a month with only 29 days (for example JewishDate.IYAR, or JewishDate.KISLEV in a year that JewishDate.isKislevShort()), the 29th (last valid date of the month) will be set
    
    Throws:
    
    IllegalArgumentException - if the day of month is < 1 or > 30, or a year of < 0 is passed in.
  - JewishCalendar
```
public JewishCalendar(int jewishYear,
              int jewishMonth,
              int jewishDayOfMonth,
              boolean inIsrael)
```
    Creates a Jewish date based on a Jewish date and whether in Israel
    
    Parameters:
    jewishYear - the Jewish year
    jewishMonth - the Jewish month. The method expects a 1 for Nissan ... 12 for Adar and 13 for Adar II. Use the constants JewishDate.NISSAN ... JewishDate.ADAR (or JewishDate.ADAR_II for a leap year Adar II) to avoid any confusion.
    jewishDayOfMonth - the Jewish day of month. If 30 is passed in for a month with only 29 days (for example JewishDate.IYAR, or JewishDate.KISLEV in a year that JewishDate.isKislevShort()), the 29th (last valid date of the month) will be set
    inIsrael - whether in Israel. This affects Yom Tov and Parsha calculations
- Method Detail
  - isUseModernHolidays
```
public boolean isUseModernHolidays()
```
    Is this calendar set to return modern Israeli national holidays. By default this value is false. The holidays are: "Yom HaShoah", "Yom Hazikaron", "Yom Ha'atzmaut" and "Yom Yerushalayim"
    
    Returns:
    the useModernHolidays true if set to return modern Israeli national holidays
  - setUseModernHolidays
```
public void setUseModernHolidays(boolean useModernHolidays)
```
    Seth the calendar to return modern Israeli national holidays. By default this value is false. The holidays are: "Yom HaShoah", "Yom Hazikaron", "Yom Ha'atzmaut" and "Yom Yerushalayim"
    
    Parameters:
    useModernHolidays - the useModernHolidays to set
  - setInIsrael
```
public void setInIsrael(boolean inIsrael)
```
    Sets whether to use Israel parsha and holiday scheme or not. Default is false.
    
    Parameters:
    inIsrael - set to true for calculations for Israel
  - getInIsrael
```
public boolean getInIsrael()
```
    Gets whether Israel parsha and holiday scheme is used or not. The default (if not set) is false.
    
    Returns:
    if the if the calendar is set to Israel
  - getYomTovIndex
```
public int getYomTovIndex()
```
    Returns an index of the Jewish holiday or fast day for the current day, or a null if there is no holiday for this day.
    
    Returns:
    A String containing the holiday name or an empty string if it is not a holiday.
  - isYomTov
```
public boolean isYomTov()
```
    Returns true if the current day is Yom Tov. The method returns false for Chanukah, Erev Yom tov and fast days.
    
    Returns:
    true if the current day is a Yom Tov
    See Also:
    isErevYomTov(), isTaanis()
  - isCholHamoed
```
public boolean isCholHamoed()
```
    Returns true if the current day is Chol Hamoed of Pesach or Succos.
    
    Returns:
    true if the current day is Chol Hamoed of Pesach or Succos
    See Also:
    isYomTov(), CHOL_HAMOED_PESACH, CHOL_HAMOED_SUCCOS
  - isErevYomTov
```
public boolean isErevYomTov()
```
    Returns true if the current day is erev Yom Tov. The method returns true for Erev - Pesach, Shavuos, Rosh Hashana, Yom Kippur and Succos.
    
    Returns:
    true if the current day is Erev - Pesach, Shavuos, Rosh Hashana, Yom Kippur and Succos
    See Also:
    isYomTov()
  - isErevRoshChodesh
```
public boolean isErevRoshChodesh()
```
    Returns true if the current day is Erev Rosh Chodesh. Returns false for Erev Rosh Hashana
    
    Returns:
    true if the current day is Erev Rosh Chodesh. Returns false for Erev Rosh Hashana
    See Also:
    isRoshChodesh()
  - isTaanis
```
public boolean isTaanis()
```
    Return true if the day is a Taanis (fast day). Return true for 17 of Tammuz, Tisha B'Av, Yom Kippur, Fast of Gedalyah, 10 of Teves and the Fast of Esther
    
    Returns:
    true if today is a fast day
  - getDayOfChanukah
```
public int getDayOfChanukah()
```
    Returns the day of Chanukah or -1 if it is not Chanukah.
    
    Returns:
    the day of Chanukah or -1 if it is not Chanukah.
  - isChanukah
```
public boolean isChanukah()
```
  - getParshaIndex
```
public int getParshaIndex()
```
    Returns a the index of today's parsha(ios) or a -1 if there is none. To get the name of the Parsha, use the HebrewDateFormatter.formatParsha(JewishCalendar). TODO: consider possibly return the parsha of the week for any day during the week instead of empty. To do this the simple way, create a new instance of the class in the mothod, roll it to the next shabbos. If the shabbos has no parsha, keep rolling by a week till a parsha is encountered. Possibly turn into static method that takes in a year, month, day, roll to next shabbos (not that simple with the API for date passed in) and if it is not a shabbos roll forwarde one week at a time to get the parsha. I do not think it is possible to have more than 2 shabbosim in a row without a parsha, but I may be wrong.
    
    Returns:
    the string of the parsha. Will currently return blank for weekdays and a shabbos on a yom tov.
  - isRoshChodesh
```
public boolean isRoshChodesh()
```
    Returns if the day is Rosh Chodesh. Rosh Hashana will return false
    
    Returns:
    true if it is Rosh Chodesh. Rosh Hashana will return false
  - getDayOfOmer
```
public int getDayOfOmer()
```
    Returns the int value of the Omer day or -1 if the day is not in the omer
    
    Returns:
    The Omer count as an int or -1 if it is not a day of the Omer.
  - getMoladAsDate
```
public Date getMoladAsDate()
```
    Returns the molad in Standard Time in Yerushalayim as a Date. The traditional calculation uses local time. This method subtracts 20.94 minutes (20 minutes and 56.496 seconds) from the local time (Har Habayis with a longitude of 35.2354° is 5.2354° away from the %15 timezone longitude) to get to standard time. This method intentionally uses standard time and not dailight savings time. Java will implicitly format the time to the default (or set) Timezone.
    
    Returns:
    the Date representing the moment of the molad in Yerushalayim standard time (GMT + 2)
  - getTchilasZmanKidushLevana3Days
```
public Date getTchilasZmanKidushLevana3Days()
```
    Returns the earliest time of Kiddush Levana calculated as 3 days after the molad. TODO: Currently returns the time even if it is during the day. It should return the Tzais after to the time if the zman is between Alos and Tzais.
    
    Returns:
    the Date representing the moment 3 days after the molad.
  - getTchilasZmanKidushLevana7Days
```
public Date getTchilasZmanKidushLevana7Days()
```
    Returns the earliest time of Kiddush Levana calculated as 7 days after the molad as mentioned by the Mechaber. See the Bach's opinion on this time. TODO: Currently returns the time even if it is during the day. It should return the Tzais after to the time if the zman is between Alos and Tzais.
    
    Returns:
    the Date representing the moment 7 days after the molad.
  - getSofZmanKidushLevanaBetweenMoldos
```
public Date getSofZmanKidushLevanaBetweenMoldos()
```
    Returns the latest time of Kiddush Levana according to the Maharil's opinion that it is calculated as halfway between molad and molad. This adds half the 29 days, 12 hours and 793 chalakim time between molad and molad (14 days, 18 hours, 22 minutes and 666 milliseconds) to the month's molad. TODO: Currently returns the time even if it is during the day. It should return the Alos prior to the time if the zman is between Alos and Tzais.
    
    Returns:
    the Date representing the moment halfway between molad and molad.
    See Also:
    getSofZmanKidushLevana15Days()
  - getSofZmanKidushLevana15Days
```
public Date getSofZmanKidushLevana15Days()
```
    Returns the latest time of Kiddush Levana calculated as 15 days after the molad. This is the opinion brought down in the Shulchan Aruch (Orach Chaim 426). It should be noted that some opinions hold that the Rema who brings down the opinion of the Maharil's of calculating half way between molad and mold is of the opinion that Mechaber agrees to his opinion. Also see the Aruch Hashulchan. For additional details on the subject, See Rabbi Dovid Heber's very detailed writeup in Siman Daled (chapter 4) of Shaarei Zmanim. TODO: Currently returns the time even if it is during the day. It should return the Alos prior to the time if the zman is between Alos and Tzais.
    
    Returns:
    the Date representing the moment 15 days after the molad.
    See Also:
    getSofZmanKidushLevanaBetweenMoldos()
  - getDafYomiBavli
```
public Daf getDafYomiBavli()
```
    Returns the Daf Yomi (Bavli) for the date that the calendar is set to. See the HebrewDateFormatter.formatDafYomiBavli(Daf) for the ability to format the daf in Hebrew or transliterated masechta names.
    
    Returns:
    the daf as a Daf
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class JewishDate
    
    See Also:
    Object.equals(Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class JewishDate
    
    See Also:
    Object.hashCode()

Class JewishCalendar

Field Summary

Fields inherited from class net.sourceforge.zmanim.hebrewcalendar.JewishDate

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.zmanim.hebrewcalendar.JewishDate

Methods inherited from class java.lang.Object

Field Detail

EREV_PESACH

PESACH

CHOL_HAMOED_PESACH

PESACH_SHENI

EREV_SHAVUOS

SHAVUOS

SEVENTEEN_OF_TAMMUZ

TISHA_BEAV

TU_BEAV

EREV_ROSH_HASHANA

ROSH_HASHANA

FAST_OF_GEDALYAH

EREV_YOM_KIPPUR

YOM_KIPPUR

EREV_SUCCOS

SUCCOS

CHOL_HAMOED_SUCCOS

HOSHANA_RABBA

SHEMINI_ATZERES

SIMCHAS_TORAH

CHANUKAH

TENTH_OF_TEVES

TU_BESHVAT

FAST_OF_ESTHER

PURIM

SHUSHAN_PURIM

PURIM_KATAN

ROSH_CHODESH

YOM_HASHOAH

YOM_HAZIKARON

YOM_HAATZMAUT

YOM_YERUSHALAYIM

Constructor Detail

JewishCalendar

JewishCalendar

JewishCalendar

JewishCalendar

JewishCalendar

Method Detail

isUseModernHolidays

setUseModernHolidays

setInIsrael

getInIsrael

getYomTovIndex

isYomTov

isCholHamoed

isErevYomTov

isErevRoshChodesh

isTaanis

getDayOfChanukah

isChanukah

getParshaIndex

isRoshChodesh

getDayOfOmer

getMoladAsDate

getTchilasZmanKidushLevana3Days

getTchilasZmanKidushLevana7Days

getSofZmanKidushLevanaBetweenMoldos

getSofZmanKidushLevana15Days

getDafYomiBavli

equals

hashCode