Skip to content

Commit b43cfc0

Browse files
authored
SunTimesCalculator.getSolarElevation and getSolarAzimuth now expect an Instantand not a ZonedDateTime
- JavaDoc cleanup
1 parent d6ce846 commit b43cfc0

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

src/main/java/com/kosherjava/zmanim/util/SunTimesCalculator.java

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
*/
1616
package com.kosherjava.zmanim.util;
1717

18+
import java.time.Instant;
1819
import java.time.LocalDate;
19-
import java.time.ZonedDateTime;
2020

2121
/**
2222
* Implementation of sunrise and sunset methods to calculate astronomical times. This calculator uses the Java algorithm
@@ -127,7 +127,6 @@ private static double getHoursFromMeridian(double longitude) {
127127
* @param dayOfYear the day of year
128128
* @param hoursFromMeridian hours from the meridian
129129
* @param isSunrise true for sunrise and false for sunset
130-
*
131130
* @return the approximate time of sunset or sunrise in days since midnight Jan 1st, assuming 6am and 6pm events. We
132131
* need this figure to derive the Sun's mean anomaly.
133132
*/
@@ -217,14 +216,10 @@ private static double getLocalMeanTime(double localHour, double sunRightAscensio
217216
/**
218217
* Get sunrise or sunset time in UTC, according to flag. This time is returned as a double and is not adjusted for time-zone.
219218
*
220-
* @param localDate
221-
* the <code>LocalDate</code> object to extract the day of year for calculation
222-
* @param geoLocation
223-
* The location information used for astronomical calculation of solar times.
224-
* @param zenith
225-
* Sun's zenith in degrees
226-
* @param isSunrise
227-
* True for sunrise and false for sunset.
219+
* @param localDate the <code>LocalDate</code> object to extract the day of year for calculation
220+
* @param geoLocation The location information used for astronomical calculation of solar times.
221+
* @param zenith Sun's zenith in degrees
222+
* @param isSunrise <code>true</code> for sunrise and false for sunset.
228223
* @return the time as a double. If an error was encountered in the calculation (expected behavior for some locations such as
229224
* near the poles, {@link Double#NaN} will be returned.
230225
*/
@@ -276,7 +271,7 @@ public double getUTCMidnight(LocalDate localDate, GeoLocation geoLocation) {
276271
* {@link NOAACalculator} instead.
277272
*/
278273
@Override
279-
public double getSolarAzimuth(ZonedDateTime zdt, GeoLocation geoLocation) {
274+
public double getSolarAzimuth(Instant instant, GeoLocation geoLocation) {
280275
throw new UnsupportedOperationException(
281276
"The SunTimesCalculator class does not implement the getSolarAzimuth method. Use the {@link NOAACalculator} instead.");
282277
}
@@ -289,7 +284,7 @@ public double getSolarAzimuth(ZonedDateTime zdt, GeoLocation geoLocation) {
289284
* {@link NOAACalculator} instead.
290285
*/
291286
@Override
292-
public double getSolarElevation(ZonedDateTime zdt, GeoLocation geoLocation) {
287+
public double getSolarElevation(Instant instant, GeoLocation geoLocation) {
293288
throw new UnsupportedOperationException(
294289
"The SunTimesCalculator class does not implement the getSolarElevation method. Use the NOAACalculator instead.");
295290
}

0 commit comments

Comments
 (0)