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

java.lang.Object
- net.sourceforge.zmanim.AstronomicalCalendar
- - net.sourceforge.zmanim.ZmanimCalendar

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ComplexZmanimCalendar
```
public class ZmanimCalendar
extends AstronomicalCalendar
```
The ZmanimCalendar is a specialized calendar that can calculate sunrise and sunset and Jewish zmanim (religious times) for prayers and other Jewish religious duties. This class contains the main functionality of the Zmanim library. For a much more extensive list of zmanim use the ComplexZmanimCalendar that extends this class. See documentation for the ComplexZmanimCalendar and AstronomicalCalendar for simple examples on using the API.
Note: It is important to read the technical notes on top of the AstronomicalCalculator documentation.
Disclaimer:
I did my best to get accurate results but please do not rely on these zmanim for halacha lemaaseh.

Version:

1.2.1

Author:

© Eliyahu Hershfeld 2004 - 2011

Field Summary

Fields
Modifier and Type	Field and Description
`protected static double`	`ZENITH_16_POINT_1` The zenith of 16.1° below geometric zenith (90°).
`protected static double`	`ZENITH_8_POINT_5` The zenith of 8.5° below geometric zenith (90°).

Fields inherited from class net.sourceforge.zmanim.AstronomicalCalendar
ASTRONOMICAL_ZENITH, CIVIL_ZENITH, GEOMETRIC_ZENITH, HOUR_MILLIS, MINUTE_MILLIS, NAUTICAL_ZENITH

Constructor Summary

Constructors
Constructor and Description
`ZmanimCalendar()` Default constructor will set a default `GeoLocation.GeoLocation()`, a default `AstronomicalCalculator` and default the calendar to the current date.
`ZmanimCalendar(GeoLocation location)` A constructor that takes a `GeoLocation` as a parameter.

Method Summary

Methods
Modifier and Type	Method and Description
`Date`	`getAlos72()` Method to return alos (dawn) calculated using 72 minutes before `sea level sunrise` (no adjustment for elevation) based on the time to walk the distance of 4 Mil at 18 minutes a Mil.
`Date`	`getAlosHashachar()` Returns alos (dawn) based on the time when the sun is 16.1° below the eastern `geometric horizon` before `sunrise`.
`Date`	`getCandleLighting()` A method to return candle lighting time.
`double`	`getCandleLightingOffset()` A method to get the offset in minutes before `sunset` which is used in calculating candle lighting time.
`Date`	`getChatzos()` This method returns chatzos (midday) following the opinion of the GRA that the day for Jewish halachic times start at `sunrise` and ends at `sunset`.
`Date`	`getMinchaGedola()` This method returns the time of mincha gedola.
`Date`	`getMinchaKetana()` This method returns the time of mincha ketana.
`Date`	`getPlagHamincha()` This method returns the time of plag hamincha.
`long`	`getShaahZmanisGra()` A method that returns a shaah zmanis ( `temporal hour`) according to the opinion of the GRA and the Baal Hatanya.
`long`	`getShaahZmanisMGA()` A method that returns a shaah zmanis (temporal hour) according to the opinion of the Magen Avraham.
`Date`	`getSofZmanShmaGRA()` This method returns the latest zman krias shema (time to recite Shema in the morning).
`Date`	`getSofZmanShmaMGA()` This method returns the latest zman krias shema (time to recite shema in the morning) in the opinion of the MGA based on alos being 72 minutes before `sunrise`.
`Date`	`getSofZmanTfilaGRA()` This method returns the latest zman tefilah (time to recite the morning prayers).
`Date`	`getSofZmanTfilaMGA()` This method returns the latest zman tfila (time to recite the morning prayers) in the opinion of the MGA based on alos being `72` minutes before `sunrise`.
`Date`	`getTzais()` A method that returns tzais (nightfall) when the sun is 8.5° below the western geometric horizon (90°) after `sunset`.
`Date`	`getTzais72()` This method returns the tzais (nightfall) based on the opinion of the Rambam and Rabainu Tam that tzais is calculated as 72 minutes, the time it takes to walk 4 Mil at 18 minutes a Mil.
`void`	`setCandleLightingOffset(double candleLightingOffset)` A method to set the offset in minutes before `sunset` that is used in calculating candle lighting time.

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

- Field Detail
  - ZENITH_16_POINT_1
```
protected static final double ZENITH_16_POINT_1
```
    The zenith of 16.1° below geometric zenith (90°). This calculation is used for determining alos (dawn) and tzais (nightfall) in some opinions. It is based on the calculation that the time between dawn and sunrise (and sunset to nightfall) is 72 minutes, the time that is takes to walk 4 mil at 18 minutes a mil (Rambam and others). The sun's position at 72 minutes before sunrise in Jerusalem on the equinox is 16.1° below geometric zenith.
    
    See Also:
    getAlosHashachar(), ComplexZmanimCalendar.getAlos16Point1Degrees(), ComplexZmanimCalendar.getTzais16Point1Degrees(), ComplexZmanimCalendar.getSofZmanShmaMGA16Point1Degrees(), ComplexZmanimCalendar.getSofZmanTfilaMGA16Point1Degrees(), ComplexZmanimCalendar.getMinchaGedola16Point1Degrees(), ComplexZmanimCalendar.getMinchaKetana16Point1Degrees(), ComplexZmanimCalendar.getPlagHamincha16Point1Degrees(), ComplexZmanimCalendar.getPlagAlos16Point1ToTzaisGeonim7Point083Degrees(), ComplexZmanimCalendar.getSofZmanShmaAlos16Point1ToSunset(), Constant Field Values
  - ZENITH_8_POINT_5
```
protected static final double ZENITH_8_POINT_5
```
    The zenith of 8.5° below geometric zenith (90°). This calculation is used for calculating alos (dawn) and tzais (nightfall) in some opinions. This calculation is based on the position of the sun 36 minutes after sunset in Jerusalem on March 16, about 4 days before the equinox, the day that a solar hour is 60 minutes, which is 8.5° below geometric zenith. The Ohr Meir considers this the time that 3 small stars are visible, which is later than the required 3 medium stars.
    
    See Also:
    getTzais(), ComplexZmanimCalendar.getTzaisGeonim8Point5Degrees(), Constant Field Values
- Constructor Detail
  - ZmanimCalendar
```
public ZmanimCalendar()
```
    Default constructor will set a default GeoLocation.GeoLocation(), a default AstronomicalCalculator and default the calendar to the current date.
    
    See Also:
    AstronomicalCalendar.AstronomicalCalendar()
  - ZmanimCalendar
```
public ZmanimCalendar(GeoLocation location)
```
    A constructor that takes a GeoLocation as a parameter.
    
    Parameters:
    location - the location
- Method Detail
  - getTzais
```
public Date getTzais()
```
    A method that returns tzais (nightfall) when the sun is 8.5° below the western geometric horizon (90°) after sunset. For information on the source of this calculation see ZENITH_8_POINT_5.
    
    Returns:
    The Date of nightfall. If the calculation can't be computed such as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach low enough below the horizon for this calculation, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    ZENITH_8_POINT_5
  - getAlosHashachar
```
public Date getAlosHashachar()
```
    Returns alos (dawn) based on the time when the sun is 16.1° below the eastern geometric horizon before sunrise. For more information the source of 16.1° see ZENITH_16_POINT_1.
    
    Returns:
    The Date of dawn. If the calculation can't be computed such as northern and southern locations even south of the Arctic Circle and north of the Antarctic Circle where the sun may not reach low enough below the horizon for this calculation, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    ZENITH_16_POINT_1
  - getAlos72
```
public Date getAlos72()
```
    Method to return alos (dawn) calculated using 72 minutes before sea level sunrise (no adjustment for elevation) based on the time to walk the distance of 4 Mil at 18 minutes a Mil. This is based on the opinion of most Rishonim who stated that the time of the Neshef (time between dawn and sunrise) does not vary by the time of year or location but purely depends on the time it takes to walk the distance of 4 Mil.
    
    Returns:
    the Date representing the time. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
  - getChatzos
```
public Date getChatzos()
```
    This method returns chatzos (midday) following the opinion of the GRA that the day for Jewish halachic times start at sunrise and ends at sunset. The returned value is identical to AstronomicalCalendar.getSunTransit()
    
    Returns:
    the Date of chatzos. If the calculation can't be computed such as in the Arctic Circle where there is at least one day where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    AstronomicalCalendar.getSunTransit()
  - getSofZmanShmaGRA
```
public Date getSofZmanShmaGRA()
```
    This method returns the latest zman krias shema (time to recite Shema in the morning). This time is 3 shaos zmaniyos (solar hours) after sea level sunrise based on the opinion of the GRA and the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 3 * getShaahZmanisGra() after sea level sunrise.
    
    Returns:
    the Date of the latest zman shema according to the GRA and Baal Hatanya. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getShaahZmanisGra()
  - getSofZmanShmaMGA
```
public Date getSofZmanShmaMGA()
```
    This method returns the latest zman krias shema (time to recite shema in the morning) in the opinion of the MGA based on alos being 72 minutes before sunrise. This time is 3 shaos zmaniyos (solar hours) after dawn based on the opinion of the MGA that the day is calculated from a dawn of 72 minutes before sunrise to nightfall of 72 minutes after sunset. This returns the time of 3 * shaos zmaniyos after dawn.
    
    Returns:
    the Date of the latest zman shema. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    ComplexZmanimCalendar.getShaahZmanis72Minutes(), getAlos72(), ComplexZmanimCalendar.getSofZmanShmaMGA72Minutes()
  - getTzais72
```
public Date getTzais72()
```
    This method returns the tzais (nightfall) based on the opinion of the Rambam and Rabainu Tam that tzais is calculated as 72 minutes, the time it takes to walk 4 Mil at 18 minutes a Mil. Even for locations above sea level, this is calculated at sea level, since the darkness level is not affected by elevation.
    
    Returns:
    the Date representing 72 minutes after sea level sunset. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned See detailed explanation on top of the AstronomicalCalendar documentation.
  - getCandleLighting
```
public Date getCandleLighting()
```
    A method to return candle lighting time. This is calculated as getCandleLightingOffset() minutes before sunset. This will return the time for any day of the week, since it can be used to calculate candle lighting time for yom tov (mid-week holidays) as well.
    
    Returns:
    candle lighting time. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getCandleLightingOffset(), setCandleLightingOffset(double)
  - getSofZmanTfilaGRA
```
public Date getSofZmanTfilaGRA()
```
    This method returns the latest zman tefilah (time to recite the morning prayers). This time is 4 hours into the day based on the opinion of the GRA and the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 4 * getShaahZmanisGra() after sea level sunrise.
    
    Returns:
    the Date of the latest zman tefilah. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getShaahZmanisGra()
  - getSofZmanTfilaMGA
```
public Date getSofZmanTfilaMGA()
```
    This method returns the latest zman tfila (time to recite the morning prayers) in the opinion of the MGA based on alos being 72 minutes before sunrise. This time is 4 shaos zmaniyos (temporal hours) after dawn based on the opinion of the MGA that the day is calculated from a dawn of 72 minutes before sunrise to nightfall of 72 minutes after sunset. This returns the time of 4 * getShaahZmanisMGA() after dawn.
    
    Returns:
    the Date of the latest zman tfila. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set), a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getShaahZmanisMGA(), getAlos72()
  - getMinchaGedola
```
public Date getMinchaGedola()
```
    This method returns the time of mincha gedola. Mincha gedola is the earliest time one can pray mincha. The Ramba"m is of the opinion that it is better to delay mincha until mincha ketana while the Ra"sh, Tur, GRA and others are of the opinion that mincha can be prayed lechatchila starting at mincha gedola. This is calculated as 6.5 sea level solar hours after sea level sunrise. This calculation is based on the opinion of the GRA and the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 6.5 * getShaahZmanisGra() after sea level sunrise.
    
    Returns:
    the Date of the time of mincha gedola. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getShaahZmanisGra(), getMinchaKetana()
  - getMinchaKetana
```
public Date getMinchaKetana()
```
    This method returns the time of mincha ketana. This is the preferred earliest time to pray mincha in the opinion of the Rambam and others. For more information on this see the documentation on mincha gedola. This is calculated as 9.5 sea level solar hours after sea level sunrise. This calculation is calculated based on the opinion of the GRA and the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 9.5 * getShaahZmanisGra() after sea level sunrise.
    
    Returns:
    the Date of the time of mincha ketana. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    getShaahZmanisGra(), getMinchaGedola()
  - getPlagHamincha
```
public Date getPlagHamincha()
```
    This method returns the time of plag hamincha. This is calculated as 10.75 hours after sunrise. This calculation is based on the opinion of the GRA and the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 10.75 * getShaahZmanisGra() after sea level sunrise.
    
    Returns:
    the Date of the time of plag hamincha. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, a null will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
  - getShaahZmanisGra
```
public long getShaahZmanisGra()
```
    A method that returns a shaah zmanis ( temporal hour) according to the opinion of the GRA and the Baal Hatanya. This calculation divides the day based on the opinion of the GRA and the Baal Hatanya that the day runs from sunrise to sunset. The calculations are based on a day from sea level sunrise to sea level sunset. The day is split into 12 equal parts with each one being a shaah zmanis. This method is similar to AstronomicalCalendar.getTemporalHour(), but all calculations are based on a sealevel sunrise and sunset. An explanation and detailed sources for not using elevation for anything besides sunrise and sunset can be found in Zmanim Kehilchasam (second edition published in 2007) by Rabbi Dovid Yehuda Bursztyn chapter 2 (pages 186-187).
    
    Returns:
    the long millisecond length of a shaah zmanis calculated from sea level sunrise to sea level sunset. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, Long.MIN_VALUE will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
    See Also:
    AstronomicalCalendar.getTemporalHour(Date, Date), AstronomicalCalendar.getSeaLevelSunrise(), AstronomicalCalendar.getSeaLevelSunset()
  - getShaahZmanisMGA
```
public long getShaahZmanisMGA()
```
    A method that returns a shaah zmanis (temporal hour) according to the opinion of the Magen Avraham. This calculation divides the day based on the opinion of the MGA that the day runs from dawn to dusk (for sof zman krias shema and tfila). Dawn for this calculation is 72 minutes before sunrise and dusk is 72 minutes after sunset. This day is split into 12 equal parts with each part being a shaah zmanis. Alternate mothods of calculating a shaah zmanis are available in the subclass ComplexZmanimCalendar.
    
    Returns:
    the long millisecond length of a shaah zmanis. If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does not set, Long.MIN_VALUE will be returned. See detailed explanation on top of the AstronomicalCalendar documentation.
  - getCandleLightingOffset
```
public double getCandleLightingOffset()
```
    A method to get the offset in minutes before sunset which is used in calculating candle lighting time. The default time used is 18 minutes before sunset. Some calendars use 15 minutes, while the custom in Jerusalem is to use a 40 minute offset. Please check the local custom for candle lighting time.
    
    Returns:
    Returns the currently set candle lighting offset in minutes.
    See Also:
    getCandleLighting(), setCandleLightingOffset(double)
  - setCandleLightingOffset
```
public void setCandleLightingOffset(double candleLightingOffset)
```
    A method to set the offset in minutes before sunset that is used in calculating candle lighting time. The default time used is 18 minutes before sunset. Some calendars use 15 minutes, while the custom in Jerusalem is to use a 40 minute offset.
    
    Parameters:
    candleLightingOffset - The candle lighting offset to set in minutes.
    See Also:
    getCandleLighting(), getCandleLightingOffset()

Class ZmanimCalendar

Disclaimer:

Field Summary

Fields inherited from class net.sourceforge.zmanim.AstronomicalCalendar

Constructor Summary

Method Summary

Methods inherited from class net.sourceforge.zmanim.AstronomicalCalendar

Methods inherited from class java.lang.Object

Field Detail

ZENITH_16_POINT_1

ZENITH_8_POINT_5

Constructor Detail

ZmanimCalendar

ZmanimCalendar

Method Detail

getTzais

getAlosHashachar

getAlos72

getChatzos

getSofZmanShmaGRA

getSofZmanShmaMGA

getTzais72

getCandleLighting

getSofZmanTfilaGRA

getSofZmanTfilaMGA

getMinchaGedola

getMinchaKetana

getPlagHamincha

getShaahZmanisGra

getShaahZmanisMGA

getCandleLightingOffset

setCandleLightingOffset