[Core] Add TimeStampMillis to TimeStampedEvent

A timestamp is more useful when that timestamp is relative to the epoch.
Unlike `System.currentTimeMillis`, `System.nanoTime` is relative to some
arbitrary point in time.

Additionally the extra granularity has no practical benefit. This is
evidenced by the stats, junit and, testng formatter which all express
the elapsed time in milliseconds.

Author: mpkorstanje

core/src/main/java/cucumber/api/Result.java

@@ -10,7 +10,7 @@
 
 public final class Result {
 
-    public final static Comparator<Result> SEVERITY = new Comparator<Result>() {
+    public static final Comparator<Result> SEVERITY = new Comparator<Result>() {
 
         @Override
         public int compare(Result a, Result b) {

core/src/main/java/cucumber/api/event/CanonicalEventOrder.java

@@ -62,17 +62,17 @@ private static final class TestCaseEventComparator implements Comparator<TestCas
 
         @Override
         public int compare(TestCaseEvent a, TestCaseEvent b) {
-            int uri = a.testCase.getUri().compareTo(b.testCase.getUri());
+            int uri = a.getTestCase().getUri().compareTo(b.getTestCase().getUri());
             if (uri != 0) {
                 return uri;
             }
 
-            int line = Integer.compare(a.testCase.getLine(), b.testCase.getLine());
+            int line = Integer.compare(a.getTestCase().getLine(), b.getTestCase().getLine());
             if(line != 0){
                 return line;
             }
 
-            return Long.compare(a.getTimeStamp(), b.getTimeStamp());
+            return Long.compare(a.getTimeStampMillis(), b.getTimeStampMillis());
         }
     }
 }

core/src/main/java/cucumber/api/event/EmbedEvent.java

@@ -6,8 +6,13 @@ public final class EmbedEvent extends TestCaseEvent {
     public final byte[] data;
     public final String mimeType;
 
+    @Deprecated
     public EmbedEvent(Long timeStamp, TestCase testCase, byte[] data, String mimeType) {
-        super(timeStamp, testCase);
+        this(timeStamp, 0, testCase, data, mimeType);
+    }
+
+    public EmbedEvent(Long timeStamp, long timeStampMillis, TestCase testCase, byte[] data, String mimeType) {
+        super(timeStamp, timeStampMillis, testCase);
         this.data = data;
         this.mimeType = mimeType;
     }

core/src/main/java/cucumber/api/event/Event.java

@@ -30,6 +30,21 @@ public interface Event {
      */
     Comparator<Event> CANONICAL_ORDER = new CanonicalEventOrder();
 
+    /**
+     * Returns a timestamp in nano seconds.
+     *
+     * @return timestamp in nano seconds
+     * @see System#nanoTime()
+     */
+    @Deprecated
     Long getTimeStamp();
 
+    /**
+     * Returns a timestamp in miliseconds since the epoch.
+     *
+     * @return timestamp in milli seconds
+     * @see System#currentTimeMillis()
+     */
+    long getTimeStampMillis();
+
 }

core/src/main/java/cucumber/api/event/SnippetsSuggestedEvent.java

@@ -10,8 +10,13 @@ public class SnippetsSuggestedEvent extends TimeStampedEvent {
     public final List<PickleLocation> stepLocations;
     public final List<String> snippets;
 
+    @Deprecated
     public SnippetsSuggestedEvent(Long timeStamp, String uri, List<PickleLocation> stepLocations, List<String> snippets) {
-        super(timeStamp);
+        this(timeStamp, 0, uri, stepLocations, snippets);
+    }
+
+    public SnippetsSuggestedEvent(Long timeStamp, long timeStampMillis, String uri, List<PickleLocation> stepLocations, List<String> snippets) {
+        super(timeStamp, timeStampMillis);
         this.uri = uri;
         this.stepLocations = stepLocations;
         this.snippets = Collections.unmodifiableList(snippets);

core/src/main/java/cucumber/api/event/TestCaseEvent.java

@@ -4,10 +4,10 @@
 
 public abstract class TestCaseEvent extends TimeStampedEvent {
 
-    final TestCase testCase;
+    private final TestCase testCase;
 
-    TestCaseEvent(Long timeStamp, TestCase testCase) {
-        super(timeStamp);
+    TestCaseEvent(Long timeStamp, long timeStampMillis, TestCase testCase) {
+        super(timeStamp, timeStampMillis);
         this.testCase = testCase;
     }
 

core/src/main/java/cucumber/api/event/TestCaseFinished.java

@@ -7,8 +7,13 @@ public final class TestCaseFinished extends TestCaseEvent {
     public final Result result;
     public final TestCase testCase;
 
+    @Deprecated
     public TestCaseFinished(Long timeStamp, TestCase testCase, Result result) {
-        super(timeStamp, testCase);
+        this(timeStamp, 0, testCase, result);
+    }
+
+    public TestCaseFinished(Long timeStamp, long timeStampMillis, TestCase testCase, Result result) {
+        super(timeStamp, timeStampMillis, testCase);
         this.testCase = testCase;
         this.result = result;
     }

core/src/main/java/cucumber/api/event/TestCaseStarted.java

@@ -4,20 +4,15 @@
 
 public final class TestCaseStarted extends TestCaseEvent {
     public final TestCase testCase;
-    private final long timeStampMillis; 
-    
+
     @Deprecated
     public TestCaseStarted(Long timeStamp, TestCase testCase) {
        this(timeStamp, 0L, testCase);
     }
 
-    public TestCaseStarted(Long timeStamp, Long timeStampMillis, TestCase testCase) {
-        super(timeStamp, testCase);
+    public TestCaseStarted(Long timeStamp, long timeStampMillis, TestCase testCase) {
+        super(timeStamp, timeStampMillis, testCase);
         this.testCase = testCase;
-        this.timeStampMillis = timeStampMillis;
     }
 
-    public long getTimeStampMillis() {
-        return timeStampMillis;
-    }
 }

core/src/main/java/cucumber/api/event/TestRunFinished.java

@@ -2,7 +2,12 @@
 
 public final class TestRunFinished extends TimeStampedEvent {
 
+    @Deprecated
     public TestRunFinished(Long timeStamp) {
-        super(timeStamp);
+        this(timeStamp, 0);
+    }
+
+    public TestRunFinished(Long timeStamp, long timeStampMillis) {
+        super(timeStamp, timeStampMillis);
     }
 }

core/src/main/java/cucumber/api/event/TestRunStarted.java

@@ -2,7 +2,12 @@
 
 public final class TestRunStarted extends TimeStampedEvent {
 
+    @Deprecated
     public TestRunStarted(Long timeStamp) {
-        super(timeStamp);
+        this(timeStamp, 0);
+    }
+
+    public TestRunStarted(Long timeStamp, long timeStampMillis) {
+        super(timeStamp, timeStampMillis);
     }
 }