Add org.apache.commons.lang3.time.DateUtils.toZonedDateTime(Date[,

TimeZone])

Author: garydgregory

src/changes/changes.xml

@@ -69,7 +69,8 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.StringUtils.indexOfAny(CharSequence, int, char...).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.concurrent.ConcurrentException.ConcurrentException(String).</action>
     <action                   type="add" dev="ggregory" due-to="Finger, Gary Gregory, Piotr P. Karwasz">Add org.apache.commons.lang3.time.DateUtils.toLocalDateTime(Date[, TimeZone]) #1385.</action>
-    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.time.DateUtils.toOffsetDateTime(Date[, TimeZone]) #1385.</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.time.DateUtils.toOffsetDateTime(Date[, TimeZone]).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add org.apache.commons.lang3.time.DateUtils.toZonedDateTime(Date[, TimeZone]).</action>
     <!-- UPDATE -->
     <action type="update" dev="ggregory" due-to="Gary Gregory">[test] Bump org.apache.commons:commons-text from 1.13.1 to 1.14.0.</action>
   </release>

src/main/java/org/apache/commons/lang3/time/DateUtils.java

@@ -21,6 +21,7 @@
 import java.time.LocalDateTime;
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
+import java.time.ZonedDateTime;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.Iterator;
@@ -1675,6 +1676,29 @@ public static OffsetDateTime toOffsetDateTime(final Date date, final TimeZone ti
         return OffsetDateTime.ofInstant(date.toInstant(), toZoneId(timeZone));
     }
 
+    /**
+     * Converts a {@link Date} to a {@link ZonedDateTime}.
+     *
+     * @param date the Date to convert, not null.
+     * @return a new ZonedDateTime.
+     * @since 3.19.0
+     */
+    public static ZonedDateTime toZonedDateTime(final Date date) {
+        return toZonedDateTime(date, TimeZone.getDefault());
+    }
+
+    /**
+     * Converts a {@link Date} to a {@link ZonedDateTime}.
+     *
+     * @param date     the Date to convert to a ZonedDateTime, not null.
+     * @param timeZone the time zone, null maps to to the default time zone.
+     * @return a new ZonedDateTime.
+     * @since 3.19.0
+     */
+    public static ZonedDateTime toZonedDateTime(final Date date, final TimeZone timeZone) {
+        return ZonedDateTime.ofInstant(date.toInstant(), toZoneId(timeZone));
+    }
+
     private static ZoneId toZoneId(final TimeZone timeZone) {
         return TimeZones.toTimeZone(timeZone).toZoneId();
     }

src/test/java/org/apache/commons/lang3/time/DateUtilsTest.java

@@ -35,6 +35,7 @@
 import java.time.OffsetDateTime;
 import java.time.ZoneId;
 import java.time.ZoneOffset;
+import java.time.ZonedDateTime;
 import java.time.temporal.ChronoUnit;
 import java.util.Calendar;
 import java.util.Date;
@@ -1319,7 +1320,8 @@ void testToLocalDateTimeTimeZone(final LocalDateTime expected, final Date date,
     @ParameterizedTest
     @MethodSource("testToLocalDateTimeTimeZone")
     void testToOffsetDateTime(final LocalDateTime expected, final Date date, final TimeZone timeZone) {
-        assertEquals(OffsetDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault()), DateUtils.toOffsetDateTime(date));
+        final OffsetDateTime offsetDateTime = DateUtils.toOffsetDateTime(date);
+        assertEquals(OffsetDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault()), offsetDateTime);
     }
 
     @ParameterizedTest
@@ -1328,6 +1330,24 @@ void testToOffsetDateTimeTimeZone(final LocalDateTime expected, final Date date,
         assertEquals(expected, DateUtils.toOffsetDateTime(date, timeZone).toLocalDateTime());
     }
 
+    @ParameterizedTest
+    @MethodSource("testToLocalDateTimeTimeZone")
+    void testToZonedDateTime(final LocalDateTime expected, final Date date, final TimeZone timeZone) {
+        final ZonedDateTime zonedDateTime = DateUtils.toZonedDateTime(date);
+        assertEquals(ZonedDateTime.ofInstant(date.toInstant(), ZoneId.systemDefault()), zonedDateTime);
+        // Using atZone()
+        assertEquals(date.toInstant().atZone(ZoneId.systemDefault()), zonedDateTime);
+    }
+
+    @ParameterizedTest
+    @MethodSource("testToLocalDateTimeTimeZone")
+    void testToZonedDateTimeTimeZone(final LocalDateTime expected, final Date date, final TimeZone timeZone) {
+        final ZonedDateTime zonedDateTime = DateUtils.toZonedDateTime(date, timeZone);
+        assertEquals(expected, zonedDateTime.toOffsetDateTime().toLocalDateTime());
+        // Using atZone()
+        assertEquals(date.toInstant().atZone(TimeZones.toTimeZone(timeZone).toZoneId()), zonedDateTime);
+    }
+
     /**
      * Tests various values with the trunc method.
      *