Adding labels to split StopWatch feature - refactor based on PR review

Author: edelgadoh

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

@@ -253,9 +253,9 @@ public static StopWatch createStarted() {
     private long stopTimeNanos;
 
     /**
-     * The split history list.
+     * The split list.
      */
-    private List<Split> splitHistory;
+    private List<Split> splits;
 
     /**
      * Constructs a new instance.
@@ -336,13 +336,13 @@ public String getMessage() {
     }
 
     /**
-     * Gets the split history list.
+     * Gets the split list.
      *
      * @return the list of splits.
      * @since 3.19.0
      */
-    public List<Split> getSplitHistory() {
-        return Collections.unmodifiableList(splitHistory);
+    public List<Split> getSplits() {
+        return Collections.unmodifiableList(splits);
     }
 
     /**
@@ -401,7 +401,7 @@ public long getSplitNanoTime() {
         if (splitState != SplitState.SPLIT) {
             throw new IllegalStateException("Stopwatch must be split to get the split time.");
         }
-        return stopTimeNanos - startTimeNanos;
+        return splits.get(splits.size() - 1).getRight().toNanos();
     }
 
     /**
@@ -576,7 +576,7 @@ private long nanosToMillis(final long nanos) {
     public void reset() {
         runningState = State.UNSTARTED;
         splitState = SplitState.UNSPLIT;
-        splitHistory = new ArrayList<>();
+        splits = new ArrayList<>();
     }
 
     /**
@@ -644,23 +644,28 @@ public void split() {
         }
         stopTimeNanos = System.nanoTime();
         splitState = SplitState.SPLIT;
+        splits.add(new Split(String.valueOf(splits.size()), Duration.ofNanos(stopTimeNanos - startTimeNanos)));
     }
 
     /**
+     * Splits the time with a label.
+     *
      * <p>
-     * Captures the time in ns and records in a history list.
-     * The label specified is used to identify the current split.
+     * This method sets the stop time of the watch to allow a time to be extracted. The start time is unaffected, enabling {@link #unsplit()} to continue the
+     * timing from the original start point.
      * </p>
      *
      * @param label A message for string presentation.
      * @throws IllegalStateException if the StopWatch is not running.
      * @since 3.19.0
      */
-    public void recordSplit(final String label) {
+    public void split(final String label) {
         if (runningState != State.RUNNING) {
             throw new IllegalStateException("Stopwatch is not running.");
         }
-        splitHistory.add(new Split(label, System.nanoTime()));
+        stopTimeNanos = System.nanoTime();
+        splitState = SplitState.SPLIT;
+        splits.add(new Split(label, Duration.ofNanos(stopTimeNanos - startTimeNanos)));
     }
 
     /**
@@ -682,7 +687,7 @@ public void start() {
         startTimeNanos = System.nanoTime();
         startInstant = Instant.now();
         runningState = State.RUNNING;
-        splitHistory = new ArrayList<>();
+        splits = new ArrayList<>();
     }
 
     /**
@@ -735,7 +740,7 @@ public void suspend() {
     }
 
     /**
-     * Gets a summary of the split time that this StopWatch recorded as a string.
+     * Gets a summary of the last split time that this StopWatch recorded as a string.
      *
      * <p>
      * The format used is ISO 8601-like, [<em>message</em> ]<em>hours</em>:<em>minutes</em>:<em>seconds</em>.<em>milliseconds</em>.
@@ -782,36 +787,37 @@ public void unsplit() {
             throw new IllegalStateException("Stopwatch has not been split.");
         }
         splitState = SplitState.UNSPLIT;
+        splits.remove(splits.size() - 1);
     }
 
     /**
-     * Class to store details of each split.
+     * Class to store a label with duration.
      * @since 3.19.0
      */
-    public static final class Split extends ImmutablePair<String, Long> {
+    public static final class Split extends ImmutablePair<String, Duration> {
 
         /**
-         * Constructor with label and duration.
+         * Constructs a Split object with label and duration.
          * @param label Label for this split.
-         * @param timeNanos time in ns.
+         * @param duration Duration for this split.
          */
-        public Split(String label, Long timeNanos) {
-            super(label, timeNanos);
+        public Split(String label, Duration duration) {
+            super(label, duration);
         }
 
         /**
-         * Get the label of this split.
+         * Gets the label of this split.
          * @return label.
          */
         public String getLabel() {
             return getLeft();
         }
 
         /**
-         * Get the time in nanoseconds.
-         * @return time in ns.
+         * Gets the duration of this split.
+         * @return duration.
          */
-        public Long getTimeNanos() {
+        public Duration getDuration() {
             return getRight();
         }
 
@@ -821,7 +827,7 @@ public Long getTimeNanos() {
          */
         @Override
         public String toString() {
-            return String.format("Split [label=%s, timeNanos=%d])", getLabel(), getTimeNanos());
+            return String.format("Split [%s, %s])", getLabel(), getDuration());
         }
     }
 

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

@@ -26,6 +26,7 @@
 import java.io.IOException;
 import java.time.Duration;
 import java.time.Instant;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -70,8 +71,11 @@ private StopWatch createMockStopWatch(final long nanos) {
     private StopWatch set(final StopWatch watch, final long nanos) {
         try {
             final long currentNanos = System.nanoTime();
+            final List<StopWatch.Split> splits = new ArrayList<>();
+            splits.add(new StopWatch.Split(String.valueOf(0), Duration.ofNanos(nanos)));
             FieldUtils.writeField(watch, "startTimeNanos", currentNanos - nanos, true);
             FieldUtils.writeField(watch, "stopTimeNanos", currentNanos, true);
+            FieldUtils.writeField(watch, "splits", splits, true);
         } catch (final IllegalAccessException e) {
             return null;
         }
@@ -509,22 +513,22 @@ void testSplitsWithStringLabels() {
         final String thirdLabel = "three";
         watch.start();
         // starting splits
-        watch.recordSplit(firstLabel);
-        watch.recordSplit(secondLabel);
-        watch.recordSplit(thirdLabel);
+        watch.split(firstLabel);
+        watch.split(secondLabel);
+        watch.split(thirdLabel);
         watch.stop();
         // getting splits
-        final List<StopWatch.Split> splits = watch.getSplitHistory();
+        final List<StopWatch.Split> splits = watch.getSplits();
         // check size
         assertEquals(3, splits.size());
         // check labels
         assertEquals(firstLabel, splits.get(0).getLabel());
         assertEquals(secondLabel, splits.get(1).getLabel());
         assertEquals(thirdLabel, splits.get(2).getLabel());
         // check time in nanos
-        assertTrue(splits.get(0).getTimeNanos() > 0);
-        assertTrue(splits.get(1).getTimeNanos() > 0);
-        assertTrue(splits.get(2).getTimeNanos() > 0);
+        assertTrue(splits.get(0).getDuration().toNanos() > 0);
+        assertTrue(splits.get(1).getDuration().toNanos() > 0);
+        assertTrue(splits.get(2).getDuration().toNanos() > 0);
     }
 
     private int throwIOException() throws IOException {