Add support for TemporalAmount in every() functions (#3)

* Add support for TemporalAmount in every() functions

Author: sylvain-bodin

pom.xml

@@ -31,7 +31,7 @@
     <artifactId>java-timestream</artifactId>
     <description>A set of builders that create streams of java.time objects</description>
     <url>https://github.com/tginsberg/java-timestream</url>
-    <version>1.0.1-SNAPSHOT</version>
+    <version>1.0.2-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <issueManagement>

src/main/java/com/ginsberg/timestream/LocalDateStream.java

@@ -25,13 +25,14 @@
 package com.ginsberg.timestream;
 
 import java.time.LocalDate;
+import java.time.Period;
 import java.time.temporal.ChronoUnit;
 import java.util.Objects;
 import java.util.function.UnaryOperator;
 
 /**
  * A builder that creates a stream of LocalDate objects.
- *
+ * <p>
  * <pre>
  * {@code
  * // Print all of the LocalDates between now and a year from now, every other day.
@@ -47,9 +48,13 @@
  * @author Todd Ginsberg (todd@ginsberg.com)
  */
 public class LocalDateStream extends AbstractComparableStream<LocalDate> {
-    private int amount = 1;
+    private long amount = 1;
     private ChronoUnit unit = ChronoUnit.DAYS;
 
+    private LocalDateStream(final LocalDate from) {
+        super(from);
+    }
+
     /**
      * Create a LocalDateStream, starting at LocalDate.now().
      *
@@ -69,10 +74,6 @@ public static LocalDateStream from(final LocalDate from) {
         return new LocalDateStream(from);
     }
 
-    private LocalDateStream(final LocalDate from) {
-        super(from);
-    }
-
     /**
      * Set the inclusive end point of the stream, using an absolute LocalDate.
      *
@@ -88,7 +89,7 @@ public LocalDateStream to(final LocalDate to) {
      * Set the inclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in. May not be null.
+     * @param unit   The non-null unit the amount is denominated in. May not be null.
      * @return A non-null LocalDateStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -115,7 +116,7 @@ public LocalDateStream until(final LocalDate until) {
      * Set the exclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null LocalDateStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -132,7 +133,7 @@ public LocalDateStream until(int amount,
      * for this builder is 1 Day.
      *
      * @param amount The number of units to use when calculating the next element of the stream.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null LocalDateStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -146,6 +147,23 @@ public LocalDateStream every(int amount,
         return this;
     }
 
+    /**
+     * Set the duration between successive elements produced by the stream. The default
+     * for this builder is 1 Day.
+     *
+     * @param period The interval to use when calculating the next element of the stream.
+     * @return A non-null LocalDateStream.
+     * @throws java.time.temporal.UnsupportedTemporalTypeException if the period is not supported.
+     * @see ChronoUnit
+     */
+    public LocalDateStream every(Period period) {
+        Objects.requireNonNull(period);
+        this.unit = ChronoUnit.DAYS;
+        this.amount = period.get(this.unit);
+        LocalDate.now().plus(0, unit); // Fail fast test
+        return this;
+    }
+
     @Override
     UnaryOperator<LocalDate> next() {
         return date -> date.plus(isForward() ? amount : 0 - amount, unit);

src/main/java/com/ginsberg/timestream/LocalDateTimeStream.java

@@ -24,14 +24,15 @@
 
 package com.ginsberg.timestream;
 
+import java.time.Duration;
 import java.time.LocalDateTime;
 import java.time.temporal.ChronoUnit;
 import java.util.Objects;
 import java.util.function.UnaryOperator;
 
 /**
  * A builder that creates a stream of LocalDateTime objects.
- *
+ * <p>
  * <pre>
  * {@code
  * // Print all of the LocalDateTimes between now and a day from now, every other minute.
@@ -47,9 +48,13 @@
  * @author Todd Ginsberg (todd@ginsberg.com)
  */
 public class LocalDateTimeStream extends AbstractComparableStream<LocalDateTime> {
-    private int amount = 1;
+    private long amount = 1;
     private ChronoUnit unit = ChronoUnit.SECONDS;
 
+    private LocalDateTimeStream(final LocalDateTime from) {
+        super(from);
+    }
+
     /**
      * Create a LocalDateTimeStream, starting at LocalDateTime.now().
      *
@@ -69,10 +74,6 @@ public static LocalDateTimeStream from(final LocalDateTime from) {
         return new LocalDateTimeStream(from);
     }
 
-    private LocalDateTimeStream(final LocalDateTime from) {
-        super(from);
-    }
-
     /**
      * Set the inclusive end point of the stream, using an absolute LocalDateTime.
      *
@@ -88,7 +89,7 @@ public LocalDateTimeStream to(final LocalDateTime to) {
      * Set the inclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in. May not be null.
+     * @param unit   The non-null unit the amount is denominated in. May not be null.
      * @return A non-null LocalDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -115,7 +116,7 @@ public LocalDateTimeStream until(final LocalDateTime until) {
      * Set the exclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null LocalDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -132,7 +133,7 @@ public LocalDateTimeStream until(int amount,
      * for this builder is 1 Second.
      *
      * @param amount The number of units to use when calculating the next element of the stream.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null LocalDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -145,6 +146,22 @@ public LocalDateTimeStream every(int amount,
         return this;
     }
 
+    /**
+     * Set the duration between successive elements produced by the stream. The default
+     * for this builder is 1 Second.
+     *
+     * @param duration The interval to use when calculating the next element of the stream.
+     * @return A non-null LocalDateTimeStream.
+     * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
+     * @see ChronoUnit
+     */
+    public LocalDateTimeStream every(Duration duration) {
+        Objects.requireNonNull(unit);
+        this.unit = ChronoUnit.SECONDS;
+        this.amount = duration.get(this.unit);
+        return this;
+    }
+
     @Override
     UnaryOperator<LocalDateTime> next() {
         return date -> date.plus(isForward() ? amount : 0 - amount, unit);

src/main/java/com/ginsberg/timestream/YearMonthStream.java

@@ -24,14 +24,15 @@
 
 package com.ginsberg.timestream;
 
+import java.time.Period;
 import java.time.YearMonth;
 import java.time.temporal.ChronoUnit;
 import java.util.Objects;
 import java.util.function.UnaryOperator;
 
 /**
  * A builder that creates a stream of YearMonth objects.
- *
+ * <p>
  * <pre>
  * {@code
  * // Print all of the YearMonths between now and a year from now, every other month.
@@ -47,9 +48,13 @@
  * @author Todd Ginsberg (todd@ginsberg.com)
  */
 public class YearMonthStream extends AbstractComparableStream<YearMonth> {
-    private int amount = 1;
+    private long amount = 1;
     private ChronoUnit unit = ChronoUnit.MONTHS;
 
+    private YearMonthStream(final YearMonth from) {
+        super(from);
+    }
+
     /**
      * Create a YearMonthStream, starting at YearMonth.now().
      *
@@ -69,10 +74,6 @@ public static YearMonthStream from(final YearMonth from) {
         return new YearMonthStream(from);
     }
 
-    private YearMonthStream(final YearMonth from) {
-        super(from);
-    }
-
     /**
      * Set the inclusive end point of the stream, using an absolute YearMonth.
      *
@@ -88,7 +89,7 @@ public YearMonthStream to(final YearMonth to) {
      * Set the inclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in. May not be null.
+     * @param unit   The non-null unit the amount is denominated in. May not be null.
      * @return A non-null YearMonthStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -115,7 +116,7 @@ public YearMonthStream until(final YearMonth until) {
      * Set the exclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null YearMonthStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -132,7 +133,7 @@ public YearMonthStream until(int amount,
      * for this builder is 1 Month.
      *
      * @param amount The number of units to use when calculating the next element of the stream.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null YearMonthStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -146,6 +147,22 @@ public YearMonthStream every(int amount,
         return this;
     }
 
+    /**
+     * Set the duration between successive elements produced by the stream. The default
+     * for this builder is 1 Month.
+     *
+     * @return A non-null YearMonthStream.
+     * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
+     * @see ChronoUnit
+     */
+    public YearMonthStream every(Period period) {
+        Objects.requireNonNull(unit);
+        this.unit = ChronoUnit.MONTHS;
+        this.amount = period.get(this.unit);
+        YearMonth.now().plus(0, unit); // Fail fast test
+        return this;
+    }
+
     @Override
     UnaryOperator<YearMonth> next() {
         return date -> date.plus(isForward() ? amount : 0 - amount, unit);

src/main/java/com/ginsberg/timestream/ZonedDateTimeStream.java

@@ -24,14 +24,15 @@
 
 package com.ginsberg.timestream;
 
+import java.time.Duration;
 import java.time.ZonedDateTime;
 import java.time.temporal.ChronoUnit;
 import java.util.Objects;
 import java.util.function.UnaryOperator;
 
 /**
  * A builder that creates a stream of ZonedDateTime objects.
- *
+ * <p>
  * <pre>
  * {@code
  * // Print all of the ZonedDateTimes between now and a day from now, every other minute.
@@ -47,9 +48,13 @@
  * @author Todd Ginsberg (todd@ginsberg.com)
  */
 public class ZonedDateTimeStream extends AbstractComparableStream<ZonedDateTime> {
-    private int amount = 1;
+    private long amount = 1;
     private ChronoUnit unit = ChronoUnit.SECONDS;
 
+    private ZonedDateTimeStream(final ZonedDateTime from) {
+        super(from);
+    }
+
     /**
      * Create a ZonedDateTimeStream, starting at ZonedDateTime.now().
      *
@@ -69,10 +74,6 @@ public static ZonedDateTimeStream from(final ZonedDateTime from) {
         return new ZonedDateTimeStream(from);
     }
 
-    private ZonedDateTimeStream(final ZonedDateTime from) {
-        super(from);
-    }
-
     /**
      * Set the inclusive end point of the stream, using an absolute ZonedDateTime.
      *
@@ -88,7 +89,7 @@ public ZonedDateTimeStream to(final ZonedDateTime to) {
      * Set the inclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in. May not be null.
+     * @param unit   The non-null unit the amount is denominated in. May not be null.
      * @return A non-null ZonedDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -115,7 +116,7 @@ public ZonedDateTimeStream until(final ZonedDateTime until) {
      * Set the exclusive end point of the stream, using a relative duration.
      *
      * @param amount The number of units to use when calculating the duration of the stream. May be negative.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null ZonedDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -132,7 +133,7 @@ public ZonedDateTimeStream until(int amount,
      * for this builder is 1 Second.
      *
      * @param amount The number of units to use when calculating the next element of the stream.
-     * @param unit The non-null unit the amount is denominated in.
+     * @param unit   The non-null unit the amount is denominated in.
      * @return A non-null ZonedDateTimeStream.
      * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
      * @see ChronoUnit
@@ -145,6 +146,22 @@ public ZonedDateTimeStream every(int amount,
         return this;
     }
 
+    /**
+     * Set the duration between successive elements produced by the stream. The default
+     * for this builder is 1 Second.
+     *
+
+     * @return A non-null ZonedDateTimeStream.
+     * @throws java.time.temporal.UnsupportedTemporalTypeException if the unit is not supported.
+     * @see ChronoUnit
+     */
+    public ZonedDateTimeStream every(Duration duration) {
+        Objects.requireNonNull(unit);
+        this.unit = ChronoUnit.SECONDS;
+        this.amount = duration.get(this.unit);
+        return this;
+    }
+
     @Override
     UnaryOperator<ZonedDateTime> next() {
         return date -> date.plus(isForward() ? amount : 0 - amount, unit);