Calendar API cleanup

Generators/src/main/java/io/deephaven/libs/StaticCalendarMethodsGenerator.java

@@ -86,6 +86,8 @@ public static void main(String[] args) throws ClassNotFoundException, IOExceptio
                         (s) -> {
                             if (s.equals("dayOfWeek")) {
                                 return "calendarDayOfWeek";
+                            } else if (s.equals("dayOfWeekValue")) {
+                                return "calendarDayOfWeekValue";
                             } else if (s.equals("timeZone")) {
                                 return "calendarTimeZone";
                             } else {

engine/time/src/main/java/io/deephaven/time/DateTimeUtils.java

@@ -1658,7 +1658,7 @@ public static ZonedDateTime plus(@Nullable final ZonedDateTime dateTime, @Nullab
      */
     @ScriptApi
     @Nullable
-    public static LocalDate minus(@Nullable final LocalDate date, final long days) {
+    public static LocalDate minusDays(@Nullable final LocalDate date, final long days) {
         if (date == null || days == NULL_LONG) {
             return null;
         }
@@ -2751,6 +2751,52 @@ public static int hourOfDay(@Nullable final ZonedDateTime dateTime) {
         return minuteOfDay(dateTime) / 60;
     }
 
+    /**
+     * Returns athe day of the week for a {@link ZonedDateTime} in the specified time zone.
+     *
+     * @param date date to find the day of the week of
+     * @return {@code null} if either input is {@code null}; otherwise, the day of the week
+     */
+    @ScriptApi
+    public static DayOfWeek dayOfWeek(@Nullable final LocalDate date) {
+        if (date == null) {
+            return null;
+        }
+
+        return date.getDayOfWeek();
+    }
+
+    /**
+     * Returns the day of the week for an {@link Instant} in the specified time zone.
+     *
+     * @param instant time to find the day of the week of
+     * @param timeZone time zone
+     * @return {@code null} if either input is {@code null}; otherwise, the day of the week
+     */
+    @ScriptApi
+    public static DayOfWeek dayOfWeek(@Nullable final Instant instant, @Nullable final ZoneId timeZone) {
+        if (instant == null || timeZone == null) {
+            return null;
+        }
+
+        return dayOfWeek(toZonedDateTime(instant, timeZone));
+    }
+
+    /**
+     * Returns the day of the week for a {@link ZonedDateTime} in the specified time zone.
+     *
+     * @param dateTime time to find the day of the week of
+     * @return {@code null} if either input is {@code null}; otherwise, the day of the week
+     */
+    @ScriptApi
+    public static DayOfWeek dayOfWeek(@Nullable final ZonedDateTime dateTime) {
+        if (dateTime == null) {
+            return null;
+        }
+
+        return dateTime.getDayOfWeek();
+    }
+
     /**
      * Returns a 1-based int value of the day of the week for a {@link ZonedDateTime} in the specified time zone, with 1
      * being Monday and 7 being Sunday.
@@ -2759,7 +2805,7 @@ public static int hourOfDay(@Nullable final ZonedDateTime dateTime) {
      * @return {@link QueryConstants#NULL_INT} if either input is {@code null}; otherwise, the day of the week
      */
     @ScriptApi
-    public static int dayOfWeek(@Nullable final LocalDate date) {
+    public static int dayOfWeekValue(@Nullable final LocalDate date) {
         if (date == null) {
             return io.deephaven.util.QueryConstants.NULL_INT;
         }
@@ -2776,12 +2822,12 @@ public static int dayOfWeek(@Nullable final LocalDate date) {
      * @return {@link QueryConstants#NULL_INT} if either input is {@code null}; otherwise, the day of the week
      */
     @ScriptApi
-    public static int dayOfWeek(@Nullable final Instant instant, @Nullable final ZoneId timeZone) {
+    public static int dayOfWeekValue(@Nullable final Instant instant, @Nullable final ZoneId timeZone) {
         if (instant == null || timeZone == null) {
             return NULL_INT;
         }
 
-        return dayOfWeek(toZonedDateTime(instant, timeZone));
+        return dayOfWeekValue(toZonedDateTime(instant, timeZone));
     }
 
     /**
@@ -2792,7 +2838,7 @@ public static int dayOfWeek(@Nullable final Instant instant, @Nullable final Zon
      * @return {@link QueryConstants#NULL_INT} if either input is {@code null}; otherwise, the day of the week
      */
     @ScriptApi
-    public static int dayOfWeek(@Nullable final ZonedDateTime dateTime) {
+    public static int dayOfWeekValue(@Nullable final ZonedDateTime dateTime) {
         if (dateTime == null) {
             return NULL_INT;
         }

engine/time/src/main/java/io/deephaven/time/calendar/BusinessCalendar.java

@@ -147,7 +147,7 @@ private YearData getYearData(final int year) {
      *        is different from the schedule for a standard business day or weekend.
      * @throws RequirementFailure if any argument is null.
      */
-    public BusinessCalendar(final String name, final String description, final ZoneId timeZone,
+    BusinessCalendar(final String name, final String description, final ZoneId timeZone,
             final LocalDate firstValidDate, final LocalDate lastValidDate,
             final CalendarDay<LocalTime> standardBusinessDay, final Set<DayOfWeek> weekendDays,
             final Map<LocalDate, CalendarDay<Instant>> holidays) {

engine/time/src/main/java/io/deephaven/time/calendar/BusinessCalendarXMLParser.java

@@ -54,7 +54,7 @@
  * }
  * </pre>
  */
-public class BusinessCalendarXMLParser {
+class BusinessCalendarXMLParser {
 
     private static class BusinessCalendarInputs {
         private String calendarName;

engine/time/src/main/java/io/deephaven/time/calendar/Calendar.java

@@ -7,10 +7,7 @@
 import io.deephaven.base.verify.RequirementFailure;
 import io.deephaven.time.DateTimeUtils;
 
-import java.time.Instant;
-import java.time.LocalDate;
-import java.time.ZoneId;
-import java.time.ZonedDateTime;
+import java.time.*;
 import java.time.temporal.ChronoUnit;
 import java.util.ArrayList;
 import java.util.List;
@@ -22,8 +19,9 @@
  * <p>
  * A calendar is associated with a specific time zone.
  * <p>
- * Date strings must be in a format that can be parsed by {@code DateTimeUtils#parseDate}. Methods that accept strings
- * can be slower than methods written explicitly for {@code Instant}, {@code ZonedDateTime}, or {@code LocalDate}.
+ * Date strings must be in a format that can be parsed by {@link DateTimeUtils#parseLocalDate(String)}. Methods that
+ * accept strings can be slower than methods written explicitly for {@code Instant}, {@code ZonedDateTime}, or
+ * {@code LocalDate}.
  */
 public class Calendar {
 
@@ -41,7 +39,7 @@ public class Calendar {
      * @param timeZone calendar time zone.
      * @throws RequirementFailure if any parameter is {@code null}
      */
-    public Calendar(final String name, final String description, final ZoneId timeZone) {
+    Calendar(final String name, final String description, final ZoneId timeZone) {
         this.name = Require.neqNull(name, "name");
         this.description = Require.neqNull(description, "description");
         this.timeZone = Require.neqNull(timeZone, "timeZone");
@@ -105,68 +103,129 @@ public LocalDate calendarDate() {
      *
      * @return current day of the week
      */
-    public int dayOfWeek() {
+    public DayOfWeek dayOfWeek() {
         return dayOfWeek(calendarDate());
     }
 
     /**
      * The current day of the week for the calendar.
      *
      * @param date date
+     * @return current day of the week, or {@code null} if the input is {@code null}.
+     */
+    public DayOfWeek dayOfWeek(final LocalDate date) {
+        return DateTimeUtils.dayOfWeek(date);
+    }
+
+    /**
+     * The current day of the week for the calendar.
+     *
+     * @param date date
+     * @return current day of the week, or {@code null} if the input is {@code null}.
+     */
+    public DayOfWeek dayOfWeek(final String date) {
+        if (date == null) {
+            return null;
+        }
+
+        return DateTimeUtils.dayOfWeek(DateTimeUtils.parseLocalDate(date));
+    }
+
+    /**
+     * The current day of the week for the calendar.
+     *
+     * @param time time
+     * @return current day of the week, or {@code null} if the input is {@code null}.
+     */
+    public DayOfWeek dayOfWeek(final Instant time) {
+        if (time == null) {
+            return null;
+        }
+
+        return DateTimeUtils.dayOfWeek(time, timeZone);
+    }
+
+    /**
+     * The current day of the week for the calendar.
+     *
+     * @param time time
+     * @return current day of the week, or {@code null} if the input is {@code null}.
+     */
+    public DayOfWeek dayOfWeek(final ZonedDateTime time) {
+        if (time == null) {
+            return null;
+        }
+
+        return DateTimeUtils.dayOfWeek(time.toInstant(), timeZone);
+    }
+
+    /**
+     * Returns a 1-based int value of the day of the week for the calendar, where 1 is Monday and 7 is Sunday.
+     *
+     * @return current day of the week
+     */
+    public int dayOfWeekValue() {
+        return dayOfWeekValue(calendarDate());
+    }
+
+    /**
+     * Returns a 1-based int value of the day of the week for the calendar, where 1 is Monday and 7 is Sunday.
+     *
+     * @param date date
      * @return current day of the week, or {@link io.deephaven.util.QueryConstants#NULL_INT} if the input is
      *         {@code null}.
      */
-    public int dayOfWeek(final LocalDate date) {
+    public int dayOfWeekValue(final LocalDate date) {
         if (date == null) {
             return NULL_INT;
         }
 
-        return DateTimeUtils.dayOfWeek(date);
+        return DateTimeUtils.dayOfWeekValue(date);
     }
 
     /**
-     * The current day of the week for the calendar.
+     * Returns a 1-based int value of the day of the week for the calendar, where 1 is Monday and 7 is Sunday.
      *
      * @param date date
      * @return current day of the week, or {@link io.deephaven.util.QueryConstants#NULL_INT} if the input is
      *         {@code null}.
      */
-    public int dayOfWeek(final String date) {
+    public int dayOfWeekValue(final String date) {
         if (date == null) {
             return NULL_INT;
         }
 
-        return DateTimeUtils.dayOfWeek(DateTimeUtils.parseLocalDate(date));
+        return DateTimeUtils.dayOfWeekValue(DateTimeUtils.parseLocalDate(date));
     }
 
     /**
-     * The current day of the week for the calendar.
+     * Returns a 1-based int value of the day of the week for the calendar, where 1 is Monday and 7 is Sunday.
      *
      * @param time time
      * @return current day of the week, or {@link io.deephaven.util.QueryConstants#NULL_INT} if the input is
      *         {@code null}.
      */
-    public int dayOfWeek(final Instant time) {
+    public int dayOfWeekValue(final Instant time) {
         if (time == null) {
             return NULL_INT;
         }
 
-        return DateTimeUtils.dayOfWeek(time, timeZone);
+        return DateTimeUtils.dayOfWeekValue(time, timeZone);
     }
 
     /**
-     * The current day of the week for the calendar.
+     * Returns a 1-based int value of the day of the week for the calendar, where 1 is Monday and 7 is Sunday.
      *
      * @param time time
      * @return current day of the week, or {@link io.deephaven.util.QueryConstants#NULL_INT} if the input is
      *         {@code null}.
      */
-    public int dayOfWeek(final ZonedDateTime time) {
+    public int dayOfWeekValue(final ZonedDateTime time) {
         if (time == null) {
             return NULL_INT;
         }
 
-        return DateTimeUtils.dayOfWeek(time.toInstant(), timeZone);
+        return DateTimeUtils.dayOfWeekValue(time.toInstant(), timeZone);
     }
 
     // endregion
@@ -209,7 +268,7 @@ public LocalDate plusDays(final String date, final int days) {
 
     /**
      * Adds a specified number of days to an input time. Adding negative days is equivalent to subtracting days.
-     *
+     * <p>
      * Day additions are not always 24 hours. The resultant time will have the same local time as the input time, as
      * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a
      * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which
@@ -230,7 +289,7 @@ public Instant plusDays(final Instant time, final int days) {
 
     /**
      * Adds a specified number of days to an input time. Adding negative days is equivalent to subtracting days.
-     *
+     * <p>
      * Day additions are not always 24 hours. The resultant time will have the same local time as the input time, as
      * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a
      * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which
@@ -290,7 +349,7 @@ public LocalDate minusDays(final String date, final int days) {
 
     /**
      * Subtracts a specified number of days to an input time. Subtracting negative days is equivalent to adding days.
-     *
+     * <p>
      * Day subtractions are not always 24 hours. The resultant time will have the same local time as the input time, as
      * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a
      * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which
@@ -311,12 +370,12 @@ public Instant minusDays(final Instant time, final int days) {
 
     /**
      * Subtracts a specified number of days to an input time. Subtracting negative days is equivalent to adding days.
-     *
+     * <p>
      * Day subtractions are not always 24 hours. The resultant time will have the same local time as the input time, as
      * determined by the calendar's time zone. This accounts for Daylight Savings Time. For example, 2023-11-05 has a
      * daylight savings time adjustment, so '2023-11-04T14:00 ET' plus 1 day will result in '2023-11-05T15:00 ET', which
      * is a 25-hour difference.
-     *
+     * <p>
      * The resultant time will have the same time zone as the calendar. This could be different than the time zone of
      * the input {@link ZonedDateTime}.
      *

engine/time/src/main/java/io/deephaven/time/calendar/CalendarDay.java

@@ -17,7 +17,7 @@
 /**
  * Schedule for a single calendar day. The schedule contains a list of business time ranges, which are the ranges of
  * time during which businesses are open.
- *
+ * <p>
  * A business day may contain multiple business time ranges. For example, some financial exchanges have a morning and an
  * afternoon trading session. This would be represented by a business day with two business time ranges.
  *

engine/time/src/main/java/io/deephaven/time/calendar/StaticCalendarMethods.java

@@ -97,19 +97,34 @@ public class StaticCalendarMethods {
     public static  io.deephaven.time.calendar.CalendarDay<java.time.Instant> calendarDay( java.time.ZonedDateTime time ) {return Calendars.calendar().calendarDay( time );}
 
     /** @see io.deephaven.time.calendar.Calendar#dayOfWeek() */
-    public static  int calendarDayOfWeek( ) {return Calendars.calendar().dayOfWeek( );}
+    public static  java.time.DayOfWeek calendarDayOfWeek( ) {return Calendars.calendar().dayOfWeek( );}
 
     /** @see io.deephaven.time.calendar.Calendar#dayOfWeek(java.lang.String) */
-    public static  int calendarDayOfWeek( java.lang.String date ) {return Calendars.calendar().dayOfWeek( date );}
+    public static  java.time.DayOfWeek calendarDayOfWeek( java.lang.String date ) {return Calendars.calendar().dayOfWeek( date );}
 
     /** @see io.deephaven.time.calendar.Calendar#dayOfWeek(java.time.Instant) */
-    public static  int calendarDayOfWeek( java.time.Instant time ) {return Calendars.calendar().dayOfWeek( time );}
+    public static  java.time.DayOfWeek calendarDayOfWeek( java.time.Instant time ) {return Calendars.calendar().dayOfWeek( time );}
 
     /** @see io.deephaven.time.calendar.Calendar#dayOfWeek(java.time.LocalDate) */
-    public static  int calendarDayOfWeek( java.time.LocalDate date ) {return Calendars.calendar().dayOfWeek( date );}
+    public static  java.time.DayOfWeek calendarDayOfWeek( java.time.LocalDate date ) {return Calendars.calendar().dayOfWeek( date );}
 
     /** @see io.deephaven.time.calendar.Calendar#dayOfWeek(java.time.ZonedDateTime) */
-    public static  int calendarDayOfWeek( java.time.ZonedDateTime time ) {return Calendars.calendar().dayOfWeek( time );}
+    public static  java.time.DayOfWeek calendarDayOfWeek( java.time.ZonedDateTime time ) {return Calendars.calendar().dayOfWeek( time );}
+
+    /** @see io.deephaven.time.calendar.Calendar#dayOfWeekValue() */
+    public static  int calendarDayOfWeekValue( ) {return Calendars.calendar().dayOfWeekValue( );}
+
+    /** @see io.deephaven.time.calendar.Calendar#dayOfWeekValue(java.lang.String) */
+    public static  int calendarDayOfWeekValue( java.lang.String date ) {return Calendars.calendar().dayOfWeekValue( date );}
+
+    /** @see io.deephaven.time.calendar.Calendar#dayOfWeekValue(java.time.Instant) */
+    public static  int calendarDayOfWeekValue( java.time.Instant time ) {return Calendars.calendar().dayOfWeekValue( time );}
+
+    /** @see io.deephaven.time.calendar.Calendar#dayOfWeekValue(java.time.LocalDate) */
+    public static  int calendarDayOfWeekValue( java.time.LocalDate date ) {return Calendars.calendar().dayOfWeekValue( date );}
+
+    /** @see io.deephaven.time.calendar.Calendar#dayOfWeekValue(java.time.ZonedDateTime) */
+    public static  int calendarDayOfWeekValue( java.time.ZonedDateTime time ) {return Calendars.calendar().dayOfWeekValue( time );}
 
     /** @see io.deephaven.time.calendar.BusinessCalendar#diffBusinessDays(java.time.Instant,java.time.Instant) */
     public static  double diffBusinessDays( java.time.Instant start, java.time.Instant end ) {return Calendars.calendar().diffBusinessDays( start, end );}