Skip to content

Commit 838ed7f

Browse files
authored
Correct spelling of Bein Hashmashos
The second H was missing. Misspelled methods will be removed in 3.0.0. Props @compugenius Closes #199
1 parent 46f765d commit 838ed7f

File tree

1 file changed

+127
-36
lines changed

1 file changed

+127
-36
lines changed

Diff for: src/main/java/com/kosherjava/zmanim/ComplexZmanimCalendar.java

+127-36
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
158158
* @todo Hyperlink the proper sources.
159159
*
160160
* @see #getTzaisGeonim7Point083Degrees()
161-
* @see #getBainHasmashosRT13Point5MinutesBefore7Point083Degrees()
161+
* @see #getBainHashmashosRT13Point5MinutesBefore7Point083Degrees()
162162
*/
163163
protected static final double ZENITH_7_POINT_083 = GEOMETRIC_ZENITH + 7 + (5.0 / 60);
164164

@@ -198,9 +198,9 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
198198
/**
199199
* The zenith of 13.24° below {@link #GEOMETRIC_ZENITH geometric zenith} (90°). This calculation is used for
200200
* calculating Rabbeinu Tam's <em>bain hashmashos</em> according to some opinions.
201-
* NOTE: See comments on {@link #getBainHasmashosRT13Point24Degrees} for additional details about the degrees.
201+
* NOTE: See comments on {@link #getBainHashmashosRT13Point24Degrees} for additional details about the degrees.
202202
*
203-
* @see #getBainHasmashosRT13Point24Degrees
203+
* @see #getBainHashmashosRT13Point24Degrees
204204
*
205205
*/
206206
protected static final double ZENITH_13_POINT_24 = GEOMETRIC_ZENITH + 13.24;
@@ -396,7 +396,7 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
396396
* according to the Yereim. As is traditional with degrees below the horizon, this is calculated without refraction
397397
* and from the center of the sun. It would be 0.833&deg; less without this.
398398
*
399-
* @see #getBainHasmashosYereim2Point1Degrees()
399+
* @see #getBainHashmashosYereim2Point1Degrees()
400400
*/
401401
protected static final double ZENITH_MINUS_2_POINT_1 = GEOMETRIC_ZENITH - 2.1;
402402

@@ -406,7 +406,7 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
406406
* according to the Yereim. As is traditional with degrees below the horizon, this is calculated without refraction
407407
* and from the center of the sun. It would be 0.833&deg; less without this.
408408
*
409-
* @see #getBainHasmashosYereim2Point8Degrees()
409+
* @see #getBainHashmashosYereim2Point8Degrees()
410410
*/
411411
protected static final double ZENITH_MINUS_2_POINT_8 = GEOMETRIC_ZENITH - 2.8;
412412

@@ -416,7 +416,7 @@ public class ComplexZmanimCalendar extends ZmanimCalendar {
416416
* according to the Yereim. As is traditional with degrees below the horizon, this is calculated without refraction
417417
* and from the center of the sun. It would be 0.833&deg; less without this.
418418
*
419-
* @see #getBainHasmashosYereim3Point05Degrees()
419+
* @see #getBainHashmashosYereim3Point05Degrees()
420420
*/
421421
protected static final double ZENITH_MINUS_3_POINT_05 = GEOMETRIC_ZENITH - 3.05;
422422

@@ -1847,7 +1847,7 @@ public Date getMinchaGedolaAhavatShalom() {
18471847
* {@link #getMinchaGedola30Minutes()}. In the winter when 1/2 of a {@link #getShaahZmanisGra() <em>shaah zmanis</em>} is
18481848
* less than 30 minutes {@link #getMinchaGedola30Minutes()} will be returned, otherwise {@link #getMinchaGedola()}
18491849
* will be returned.
1850-
*
1850+
*
18511851
* @return the <code>Date</code> of the later of {@link #getMinchaGedola()} and {@link #getMinchaGedola30Minutes()}.
18521852
* If the calculation can't be computed such as in the Arctic Circle where there is at least one day a year
18531853
* where the sun does not rise, and one where it does not set, a null will be returned. See detailed
@@ -2241,7 +2241,7 @@ public Date getPlagAhavatShalom() {
22412241
/**
22422242
* Method to return the beginning of <em>bain hashmashos</em> of Rabbeinu Tam calculated when the sun is
22432243
* {@link #ZENITH_13_POINT_24 13.24&deg;} below the western {@link #GEOMETRIC_ZENITH geometric horizon} (90&deg;)
2244-
* after sunset. This calculation is based on the same calculation of {@link #getBainHasmashosRT58Point5Minutes()
2244+
* after sunset. This calculation is based on the same calculation of {@link #getBainHashmashosRT58Point5Minutes()
22452245
* <em>bain hashmashos</em> Rabbeinu Tam 58.5 minutes} but uses a degree-based calculation instead of 58.5 exact
22462246
* minutes. This calculation is based on the position of the sun 58.5 minutes after sunset in Jerusalem <a href=
22472247
* "https://kosherjava.com/2022/01/12/equinox-vs-equilux-zmanim-calculations/">around the equinox / equilux</a>,
@@ -2260,11 +2260,21 @@ public Date getPlagAhavatShalom() {
22602260
* {@link AstronomicalCalendar} documentation.
22612261
*
22622262
* @see #ZENITH_13_POINT_24
2263-
* @see #getBainHasmashosRT58Point5Minutes()
2263+
* @see #getBainHashmashosRT58Point5Minutes()
22642264
*/
2265-
public Date getBainHasmashosRT13Point24Degrees() {
2265+
public Date getBainHashmashosRT13Point24Degrees() {
22662266
return getSunsetOffsetByDegrees(ZENITH_13_POINT_24);
22672267
}
2268+
2269+
2270+
/**
2271+
* Misspelled method name that should be {@link #getBainHashmashosRT13Point24Degrees()}.
2272+
* @return the properly spelled version.
2273+
*/
2274+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2275+
public Date getBainHasmashosRT13Point24Degrees() {
2276+
return getBainHashmashosRT13Point24Degrees();
2277+
}
22682278

22692279
/**
22702280
* This method returns the beginning of <em>Bain hashmashos</em> of Rabbeinu Tam calculated as a 58.5
@@ -2277,9 +2287,18 @@ public Date getBainHasmashosRT13Point24Degrees() {
22772287
* documentation.
22782288
*
22792289
*/
2280-
public Date getBainHasmashosRT58Point5Minutes() {
2290+
public Date getBainHashmashosRT58Point5Minutes() {
22812291
return getTimeOffset(getElevationAdjustedSunset(), 58.5 * MINUTE_MILLIS);
22822292
}
2293+
2294+
/**
2295+
* Misspelled method name that should be {@link #getBainHashmashosRT58Point5Minutes()}.
2296+
* @return the properly spelled version.
2297+
*/
2298+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2299+
public Date getBainHasmashosRT58Point5Minutes() {
2300+
return getBainHashmashosRT58Point5Minutes();
2301+
}
22832302

22842303
/**
22852304
* This method returns the beginning of <em>bain hashmashos</em> based on the calculation of 13.5 minutes (3/4 of an
@@ -2292,9 +2311,18 @@ public Date getBainHasmashosRT58Point5Minutes() {
22922311
* documentation.
22932312
* @see #getTzaisGeonim7Point083Degrees()
22942313
*/
2295-
public Date getBainHasmashosRT13Point5MinutesBefore7Point083Degrees() {
2314+
public Date getBainHashmashosRT13Point5MinutesBefore7Point083Degrees() {
22962315
return getTimeOffset(getSunsetOffsetByDegrees(ZENITH_7_POINT_083), -13.5 * MINUTE_MILLIS);
22972316
}
2317+
2318+
/**
2319+
* Misspelled method name that should be {@link #getBainHashmashosRT13Point5MinutesBefore7Point083Degrees()}.
2320+
* @return the properly spelled version.
2321+
*/
2322+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2323+
public Date getBainHasmashosRT13Point5MinutesBefore7Point083Degrees() {
2324+
return getBainHashmashosRT13Point5MinutesBefore7Point083Degrees();
2325+
}
22982326

22992327
/**
23002328
* This method returns the beginning of <em>bain hashmashos</em> of Rabbeinu Tam calculated according to the
@@ -2308,16 +2336,24 @@ public Date getBainHasmashosRT13Point5MinutesBefore7Point083Degrees() {
23082336
* calculation, a null will be returned. See detailed explanation on top of the {@link AstronomicalCalendar}
23092337
* documentation.
23102338
*/
2311-
public Date getBainHasmashosRT2Stars() {
2339+
public Date getBainHashmashosRT2Stars() {
23122340
Date alos19Point8 = getAlos19Point8Degrees();
23132341
Date sunrise = getElevationAdjustedSunrise();
23142342
if (alos19Point8 == null || sunrise == null) {
23152343
return null;
23162344
}
2317-
23182345
return getTimeOffset(getElevationAdjustedSunset(), (sunrise.getTime() - alos19Point8.getTime()) * (5 / 18d));
23192346
}
23202347

2348+
/**
2349+
* Misspelled method name that should be {@link #getBainHashmashosRT2Stars()}.
2350+
* @return the properly spelled version.
2351+
*/
2352+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2353+
public Date getBainHasmashosRT2Stars() {
2354+
return getBainHashmashosRT2Stars();
2355+
}
2356+
23212357
/**
23222358
* This method returns the beginning of <em>bain hashmashos</em> (twilight) according to the <a href=
23232359
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as 18 minutes
@@ -2328,12 +2364,21 @@ public Date getBainHasmashosRT2Stars() {
23282364
* Arctic Circle where there is at least one day a year where the sun does not rise, and one where it does
23292365
* not set, a null will be returned. See detailed explanation on top of the {@link AstronomicalCalendar}
23302366
* documentation.
2331-
* @see #getBainHasmashosYereim3Point05Degrees()
2367+
* @see #getBainHashmashosYereim3Point05Degrees()
23322368
*/
2333-
public Date getBainHasmashosYereim18Minutes() {
2369+
public Date getBainHashmashosYereim18Minutes() {
23342370
return getTimeOffset(getElevationAdjustedSunset(), -18 * MINUTE_MILLIS);
23352371
}
23362372

2373+
/**
2374+
* Misspelled method name that should be {@link #getBainHashmashosYereim18Minutes()}.
2375+
* @return the properly spelled version.
2376+
*/
2377+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2378+
public Date getBainHasmashosYereim18Minutes() {
2379+
return getBainHashmashosYereim18Minutes();
2380+
}
2381+
23372382
/**
23382383
* This method returns the beginning of <em>bain hashmashos</em> (twilight) according to the <a href=
23392384
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as the sun's
@@ -2359,14 +2404,24 @@ public Date getBainHasmashosYereim18Minutes() {
23592404
* {@link AstronomicalCalendar} documentation.
23602405
*
23612406
* @see #ZENITH_MINUS_3_POINT_05
2362-
* @see #getBainHasmashosYereim18Minutes()
2363-
* @see #getBainHasmashosYereim2Point8Degrees()
2364-
* @see #getBainHasmashosYereim2Point1Degrees()
2407+
* @see #getBainHashmashosYereim18Minutes()
2408+
* @see #getBainHashmashosYereim2Point8Degrees()
2409+
* @see #getBainHashmashosYereim2Point1Degrees()
23652410
*/
2366-
public Date getBainHasmashosYereim3Point05Degrees() {
2411+
public Date getBainHashmashosYereim3Point05Degrees() {
23672412
return getSunsetOffsetByDegrees(ZENITH_MINUS_3_POINT_05);
23682413
}
23692414

2415+
/**
2416+
* Misspelled method name that should be {@link #getBainHashmashosYereim3Point05Degrees()}.
2417+
* @return the properly spelled version.
2418+
*/
2419+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2420+
public Date getBainHasmashosYereim3Point05Degrees() {
2421+
return getBainHashmashosYereim3Point05Degrees();
2422+
}
2423+
2424+
23702425
/**
23712426
* This method returns the beginning of <em>bain hashmashos</em> (twilight) according to the <a href=
23722427
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as 16.875
@@ -2378,12 +2433,21 @@ public Date getBainHasmashosYereim3Point05Degrees() {
23782433
* not set, a null will be returned. See detailed explanation on top of the {@link AstronomicalCalendar}
23792434
* documentation.
23802435
*
2381-
* @see #getBainHasmashosYereim2Point8Degrees()
2436+
* @see #getBainHashmashosYereim2Point8Degrees()
23822437
*/
2383-
public Date getBainHasmashosYereim16Point875Minutes() {
2438+
public Date getBainHashmashosYereim16Point875Minutes() {
23842439
return getTimeOffset(getElevationAdjustedSunset(), -16.875 * MINUTE_MILLIS);
23852440
}
23862441

2442+
/**
2443+
* Misspelled method name that should be {@link #getBainHashmashosYereim16Point875Minutes()}.
2444+
* @return the properly spelled version.
2445+
*/
2446+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2447+
public Date getBainHasmashosYereim16Point875Minutes() {
2448+
return getBainHashmashosYereim16Point875Minutes();
2449+
}
2450+
23872451
/**
23882452
* This method returns the beginning of <em>bain hashmashos</em> (twilight) according to the <a href=
23892453
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as the sun's
@@ -2392,22 +2456,32 @@ public Date getBainHasmashosYereim16Point875Minutes() {
23922456
* its position 16.875 minutes or 3/4 of an 18-minute <em>Mil</em> before sunset. According to the Yereim, <em>bain
23932457
* hashmashos</em> starts 3/4 of a <em>Mil</em> before sunset and <em>tzais</em> or nightfall starts at sunset.
23942458
* Details, including how the degrees were calculated can be seen in the documentation of
2395-
* {@link #getBainHasmashosYereim3Point05Degrees()}.
2459+
* {@link #getBainHashmashosYereim3Point05Degrees()}.
23962460
*
23972461
* @return the <code>Date</code> of the sun's position 2.8&deg; minutes before sunset. If the calculation can't
23982462
* be computed such as in the Arctic Circle where there is at least one day a year where the sun does not
23992463
* rise, and one where it does not set, a null will be returned. See detailed explanation on top of the
24002464
* {@link AstronomicalCalendar} documentation.
24012465
*
24022466
* @see #ZENITH_MINUS_2_POINT_8
2403-
* @see #getBainHasmashosYereim16Point875Minutes()
2404-
* @see #getBainHasmashosYereim3Point05Degrees()
2405-
* @see #getBainHasmashosYereim2Point1Degrees()
2467+
* @see #getBainHashmashosYereim16Point875Minutes()
2468+
* @see #getBainHashmashosYereim3Point05Degrees()
2469+
* @see #getBainHashmashosYereim2Point1Degrees()
24062470
*/
2407-
public Date getBainHasmashosYereim2Point8Degrees() {
2471+
public Date getBainHashmashosYereim2Point8Degrees() {
24082472
return getSunsetOffsetByDegrees(ZENITH_MINUS_2_POINT_8);
24092473
}
24102474

2475+
/**
2476+
* Misspelled method name that should be {@link #getBainHashmashosYereim2Point8Degrees()}.
2477+
* @return the properly spelled version.
2478+
*/
2479+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2480+
public Date getBainHasmashosYereim2Point8Degrees() {
2481+
return getBainHashmashosYereim2Point8Degrees();
2482+
}
2483+
2484+
24112485
/**
24122486
* This method returns the beginning of <em>bain hashmashos</em> (twilight) according to the <a href=
24132487
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as 13.5 minutes
@@ -2419,12 +2493,21 @@ public Date getBainHasmashosYereim2Point8Degrees() {
24192493
* not set, a null will be returned. See detailed explanation on top of the {@link AstronomicalCalendar}
24202494
* documentation.
24212495
*
2422-
* @see #getBainHasmashosYereim2Point1Degrees()
2496+
* @see #getBainHashmashosYereim2Point1Degrees()
24232497
*/
2424-
public Date getBainHasmashosYereim13Point5Minutes() {
2498+
public Date getBainHashmashosYereim13Point5Minutes() {
24252499
return getTimeOffset(getElevationAdjustedSunset(), -13.5 * MINUTE_MILLIS);
24262500
}
24272501

2502+
/**
2503+
* Misspelled method name that should be {@link #getBainHashmashosYereim13Point5Minutes()}.
2504+
* @return the properly spelled version.
2505+
*/
2506+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2507+
public Date getBainHasmashosYereim13Point5Minutes() {
2508+
return getBainHashmashosYereim13Point5Minutes();
2509+
}
2510+
24282511
/**
24292512
* This method returns the beginning of <em>bain hashmashos</em> according to the <a href=
24302513
* "https://en.wikipedia.org/wiki/Eliezer_ben_Samuel">Yereim (Rabbi Eliezer of Metz)</a> calculated as the sun's
@@ -2433,22 +2516,31 @@ public Date getBainHasmashosYereim13Point5Minutes() {
24332516
* Yerushalayim, its position 13.5 minutes or 3/4 of an 18-minute <em>Mil</em> before sunset. According to the Yereim,
24342517
* <em>bain hashmashos</em> starts 3/4 of a <em>mil</em> before sunset and <em>tzais</em> or nightfall starts at sunset.
24352518
* Details, including how the degrees were calculated can be seen in the documentation of
2436-
* {@link #getBainHasmashosYereim3Point05Degrees()}.
2519+
* {@link #getBainHashmashosYereim3Point05Degrees()}.
24372520
*
24382521
* @return the <code>Date</code> of the sun's position 2.1&deg; minutes before sunset. If the calculation can't
24392522
* be computed such as in the Arctic Circle where there is at least one day a year where the sun does not
24402523
* rise, and one where it does not set, a null will be returned. See detailed explanation on top of the
24412524
* {@link AstronomicalCalendar} documentation.
24422525
*
24432526
* @see #ZENITH_MINUS_2_POINT_1
2444-
* @see #getBainHasmashosYereim13Point5Minutes()
2445-
* @see #getBainHasmashosYereim2Point8Degrees()
2446-
* @see #getBainHasmashosYereim3Point05Degrees()
2527+
* @see #getBainHashmashosYereim13Point5Minutes()
2528+
* @see #getBainHashmashosYereim2Point8Degrees()
2529+
* @see #getBainHashmashosYereim3Point05Degrees()
24472530
*/
2448-
public Date getBainHasmashosYereim2Point1Degrees() {
2531+
public Date getBainHashmashosYereim2Point1Degrees() {
24492532
return getSunsetOffsetByDegrees(ZENITH_MINUS_2_POINT_1);
24502533
}
24512534

2535+
/**
2536+
* Misspelled method name that should be {@link #getBainHashmashosYereim2Point1Degrees()}.
2537+
* @return the properly spelled version.
2538+
*/
2539+
@Deprecated // (forRemoval=true) // add back once Java 9 is the minimum supported version
2540+
public Date getBainHasmashosYereim2Point1Degrees() {
2541+
return getBainHashmashosYereim2Point1Degrees();
2542+
}
2543+
24522544
/**
24532545
* This method returns the <em>tzais</em> (nightfall) based on the opinion of the <em>Geonim</em> calculated at the
24542546
* sun's position at {@link #ZENITH_3_POINT_7 3.7&deg;} below the western horizon.
@@ -3904,7 +3996,6 @@ public Date getSofZmanBiurChametzBaalHatanya() {
39043996
* sea level solar hours} after {@link #getSunriseBaalHatanya() <em>netz amiti</em> (sunrise)}. This calculation is based
39053997
* on the opinion of the Baal Hatanya that the day is calculated from sunrise to sunset. This returns the time 6.5
39063998
* * {@link #getShaahZmanisBaalHatanya()} after {@link #getSunriseBaalHatanya() <em>netz amiti</em> ("real" sunrise)}.
3907-
*
39083999
* @see #getMinchaGedola(Date, Date)
39094000
* @see #getShaahZmanisBaalHatanya()
39104001
* @see #getMinchaKetanaBaalHatanya()
@@ -4153,7 +4244,7 @@ public Date getSofZmanTfilaGRASunriseToFixedLocalChatzos() {
41534244
* in the Arctic Circle where there is at least one day a year where the sun does not rise, and one where it
41544245
* does not set, a null will be returned. See detailed explanation on top of the {@link AstronomicalCalendar}
41554246
* documentation.
4156-
*
4247+
*
41574248
* @see #getMinchaGedola()
41584249
* @see #getFixedLocalChatzos()
41594250
* @see #getMinchaKetanaGRAFixedLocalChatzosToSunset

0 commit comments

Comments
 (0)