Skip to content

Commit c2252d9

Browse files
authored
More JavaDoc Corrctions for elevation adjusted zmanim
Thanks @YSCohen
1 parent f68ceab commit c2252d9

1 file changed

Lines changed: 39 additions & 36 deletions

File tree

src/main/java/com/kosherjava/zmanim/ComprehensiveZmanimCalendar.java

Lines changed: 39 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -859,9 +859,10 @@ public Date getAlos60() {
859859
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> so the time for 4 mil is
860860
* 72 minutes which is 1/10th of a day (12 * 60 = 720) based on the day being from {@link #getSeaLevelSunrise() sea
861861
* level sunrise} to {@link #getSeaLevelSunset() sea level sunset} or {@link #getSunrise() sunrise} to {@link #getSunset()
862-
* sunset} (depending on the {@link #isUseElevation()} setting). The actual calculation is {@link #getSeaLevelSunrise()} -
863-
* ({@link #getShaahZmanisGra()} * 1.2). This calculation is used in the calendars published by the <a href=
864-
* "https://en.wikipedia.org/wiki/Central_Rabbinical_Congress">Hisachdus Harabanim D'Artzos Habris Ve'Canada</a>.
862+
* sunset} (depending on the {@link #isUseElevation()} setting). The actual calculation is {@link
863+
* #getElevationAdjustedSunrise()} - ({@link #getShaahZmanisGra()} * 1.2). This calculation is used in the calendars
864+
* published by the <a href="https://en.wikipedia.org/wiki/Central_Rabbinical_Congress">Hisachdus Harabanim D'Artzos Habris
865+
* Ve'Canada</a>.
865866
*
866867
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
867868
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -900,7 +901,7 @@ public Date getAlos96() {
900901
* mil is 90 minutes which is 1/8th of a day (12 * 60) / 8 = 90. The day is calculated from {@link
901902
* #getSeaLevelSunrise() sea level sunrise} to {@link #getSeaLevelSunset() sea level sunset} or {@link #getSunrise()
902903
* sunrise} to {@link #getSunset() sunset} (depending on the {@link #isUseElevation()}. The actual calculation used
903-
* is {@link #getSunrise()} - ({@link #getShaahZmanisGra()} * 1.5).
904+
* is {@link #getElevationAdjustedSunrise()} - ({@link #getShaahZmanisGra()} * 1.5).
904905
*
905906
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
906907
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -919,8 +920,8 @@ public Date getAlos90Zmanis() {
919920
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> so the time for 4 mil is 96
920921
* minutes which is 1/7.5th of a day (12 * 60 / 7.5 = 96). The day is calculated from {@link #getSeaLevelSunrise() sea
921922
* level sunrise} to {@link #getSeaLevelSunset() sea level sunset} or {@link #getSunrise() sunrise} to {@link #getSunset()
922-
* sunset} (depending on the {@link #isUseElevation()}. The actual calculation used is {@link #getSunrise()} -
923-
* ({@link #getShaahZmanisGra()} * 1.6).
923+
* sunset} (depending on the {@link #isUseElevation()}. The actual calculation used is {@link #getElevationAdjustedSunrise()}
924+
* - ({@link #getShaahZmanisGra()} * 1.6).
924925
*
925926
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
926927
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -933,8 +934,9 @@ public Date getAlos96Zmanis() {
933934
}
934935

935936
/**
936-
* Method to return <em>alos</em> (dawn) calculated using 90 minutes before {@link #getSeaLevelSunrise() sea level
937-
* sunrise} based on the time to walk the distance of 4 <a href=
937+
* Method to return <em>alos</em> (dawn) calculated using 90 minutes before {@link #getSunrise() sunrise} or
938+
* {@link #getSeaLevelSunrise() sea level sunrise} (depending on the {@link #isUseElevation()} setting) based
939+
* on the time to walk the distance of 4 <a href=
938940
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> at 22.5 minutes a
939941
* mil. Time-based offset calculations for <em>alos</em> are based on the opinion of the <em><a href=
940942
* "https://en.wikipedia.org/wiki/Rishonim">Rishonim</a></em> who stated that the time of the <em>Neshef</em>
@@ -952,14 +954,15 @@ public Date getAlos90() {
952954

953955
/**
954956
* This method should be used <em>lechumra</em> only and returns <em>alos</em> (dawn) calculated using 120 minutes
955-
* before {@link #getSeaLevelSunrise() sea level sunrise} (no adjustment for elevation is made) based on the time
956-
* to walk the distance of 5 <a href="https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement"
957-
* >mil</a> (<em>Ula</em>) at 24 minutes a mil. Time based offset calculations for <em>alos</em> are
958-
* based on the* opinion of the <em><a href="https://en.wikipedia.org/wiki/Rishonim">Rishonim</a>
959-
* </em> who stated that the time of the <em>neshef</em> (time between dawn and sunrise) does not vary by the time of
960-
* year or location but purely depends on the time it takes to walk the distance of 5 mil (<em>Ula</em>). Since
961-
* this time is extremely early, it should only be used <em>lechumra</em>, such as not eating after this time on a fast
962-
* day, and not as the start time for <em>mitzvos</em> that can only be performed during the day.
957+
* before {@link #getSunrise() sunrise} or {@link #getSeaLevelSunrise() sea level sunrise} (depending on the {@link
958+
* #isUseElevation()} setting) based on the time to walk the distance of 5 <a href=
959+
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> (<em>Ula</em>) at 24 minutes a
960+
* mil. Time based offset calculations for <em>alos</em> are based on the* opinion of the <em><a href=
961+
* "https://en.wikipedia.org/wiki/Rishonim">Rishonim</a></em> who stated that the time of the <em>neshef</em> (time
962+
* between dawn and sunrise) does not vary by the time of year or location but purely depends on the time it takes to
963+
* walk the distance of 5 mil (<em>Ula</em>). Since this time is extremely early, it should only be used <em>lechumra</em>,
964+
* such as not eating after this time on a fast day, and not as the start time for <em>mitzvos</em> that can only be
965+
* performed during the day.
963966
*
964967
* @deprecated This method should be used <em>lechumra</em> only (such as stopping to eat at this time on a fast day),
965968
* since it returns a very early time, and if used <em>lekula</em> can result in doing <em>mitzvos hayom</em>
@@ -2775,8 +2778,8 @@ public Date getTzaisGeonim9Point75Degrees() {
27752778
* "https://he.wikipedia.org/wiki/%D7%9E%D7%9C%D7%9B%D7%99%D7%90%D7%9C_%D7%A6%D7%91%D7%99_%D7%98%D7%A0%D7%A0%D7%91%D7%95%D7%99%D7%9D"
27762779
* >Divrei Malkiel</a> that the time to walk the distance of a <a href=
27772780
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> is 15 minutes, for a total of 60 minutes
2778-
* for 4 mil after {@link #getElevationAdjustedSunset() elevation adjusted sunset}. See detailed documentation explaining the 60 minute
2779-
* concept at {@link #getAlos60()}.
2781+
* for 4 mil after {@link #getSunset() sunset} or {@link #getSeaLevelSunset() sea level sunset} (depending on the {@link
2782+
* #isUseElevation()} setting). See detailed documentation explaining the 60 minute concept at {@link #getAlos60()}.
27802783
*
27812784
* @return the <code>Date</code> representing 60 minutes after sea level sunset. If the calculation can't be
27822785
* computed such as in the Arctic Circle where there is at least one day a year where the sun does not rise,
@@ -3038,13 +3041,13 @@ public Date getTzais96Zmanis() {
30383041
}
30393042

30403043
/**
3041-
* Method to return <em>tzais</em> (dusk) calculated as 90 minutes after {@link #getElevationAdjustedSunset()
3042-
* elevation adjusted sunset}. This method returns <em>tzais</em> (nightfall) based on the opinion of the Magen Avraham
3043-
* that the time to walk the distance of a <a href="https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement"
3044-
* >mil</a> according to the <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a>'s opinion is 18 minutes, for a
3045-
* total of 90 minutes based on the opinion of Ula who calculated <em>tzais</em> as 5 mil after elevation adjusted
3046-
* <em>shkiah</em> (sunset). A similar calculation {@link #getTzais19Point8Degrees()} uses solar position* calculations based
3047-
* on this time.
3044+
* Method to return <em>tzais</em> (dusk) calculated as 90 minutes after {@link #getSunset() sunset} or {@link
3045+
* #getSeaLevelSunset() sea level sunset} (depending on the {@link #isUseElevation()} setting). This method returns
3046+
* <em>tzais</em> (nightfall) based on the opinion of the Magen Avraham that the time to walk the distance of a <a href=
3047+
* "https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a> according to the <a href=
3048+
* "https://en.wikipedia.org/wiki/Maimonides">Rambam</a>'s opinion is 18 minutes, for a total of 90 minutes based on the
3049+
* opinion of Ula who calculated <em>tzais</em> as 5 mil after elevation adjusted <em>shkiah</em> (sunset). A similar
3050+
* calculation {@link #getTzais19Point8Degrees()} uses solar position* calculations based on this time.
30483051
*
30493052
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
30503053
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,
@@ -3062,11 +3065,11 @@ public Date getTzais90() {
30623065
* of <a href="https://en.wikipedia.org/wiki/Avraham_Chaim_Naeh">Rav Chaim Naeh</a> that the time to walk the
30633066
* distance of a <a href="https://en.wikipedia.org/wiki/Biblical_and_Talmudic_units_of_measurement">mil</a>
30643067
* according to the <a href="https://en.wikipedia.org/wiki/Maimonides">Rambam</a>'s opinion is 2/5 of an hour (24 minutes)
3065-
* for a total of 120 minutes based on the opinion of <em>Ula</em> who calculated <em>tzais</em> as 5 mil after
3066-
* sea level <em>shkiah</em> (sunset). A similar calculation {@link #getTzais26Degrees()} uses degree-based calculations
3067-
* based on this 120 minute calculation. Since the <em>zman</em> is extremely late and at a point that is long past the
3068-
* 18&deg; point where the darkest point is reached, it should only be used <em>lechumra</em>, such as delaying the start
3069-
* of nighttime <em>mitzvos</em>.
3068+
* for a total of 120 minutes based on the opinion of <em>Ula</em> who calculated <em>tzais</em> as 5 mil after {@link
3069+
* #getSunset() sunset} or {@link #getSeaLevelSunset() sea level sunset} (depending on the {@link #isUseElevation()} setting).
3070+
* A similar calculation {@link #getTzais26Degrees()} uses degree-based calculations based on this 120 minute calculation.
3071+
* Since the <em>zman</em> is extremely late and at a point that is long past the 18&deg; point where the darkest point is
3072+
* reached, it should only be used <em>lechumra</em>, such as delaying the start of nighttime <em>mitzvos</em>.
30703073
*
30713074
* @deprecated This method should be used <em>lechumra</em> only since it returns a very late time, and if used
30723075
* <em>lekula</em> can result in <em>chillul Shabbos</em> etc. There is no current plan to remove this
@@ -3183,8 +3186,8 @@ public Date getTzais19Point8Degrees() {
31833186
}
31843187

31853188
/**
3186-
* A method to return <em>tzais</em> (dusk) calculated as 96 minutes after {@link #getElevationAdjustedSunset()
3187-
* elevation adjusted sunset}. For information on how
3189+
* A method to return <em>tzais</em> (dusk) calculated as 96 minutes after {@link #getSunset() sunset} or {@link
3190+
* #getSeaLevelSunset() sea level sunset} (depending on the {@link #isUseElevation()} setting). For information on how
31883191
* this is calculated see the comments on {@link #getAlos96()}.
31893192
*
31903193
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
@@ -4267,10 +4270,10 @@ public Date getPlagHaminchaGRAFixedLocalChatzosToSunset() {
42674270
}
42684271

42694272
/**
4270-
* Method to return <em>tzais</em> (dusk) calculated as 50 minutes after {@link #getElevationAdjustedSunset()
4271-
* elevation adjusted sunset}. This method returns <em>tzais</em> (nightfall) based on the opinion of Rabbi Moshe
4272-
* Feinstein for the New York area. This time should not be used for latitudes other than ones similar to the
4273-
* latitude of the NY area.
4273+
* Method to return <em>tzais</em> (dusk) calculated as 50 minutes after {@link #getSunset() sunset} or {@link
4274+
* #getSeaLevelSunset() sea level sunset} (depending on the {@link #isUseElevation()} setting). This method returns
4275+
* <em>tzais</em> (nightfall) based on the opinion of Rabbi Moshe Feinstein for the New York area. This time should
4276+
* not be used for latitudes other than ones similar to the latitude of the NY area.
42744277
*
42754278
* @return the <code>Date</code> representing the time. If the calculation can't be computed such as in the Arctic
42764279
* Circle where there is at least one day a year where the sun does not rise, and one where it does not set,

0 commit comments

Comments
 (0)