Changeset 18 for timeline/src

Timestamp:

06/11/20 16:34:40 (4 years ago)

Author:

bart

Message:

Update to version 1.41

Location:

timeline/src/main/java/geniusweb/progress

Files:

• Progress.java (modified) (2 diffs)
• ProgressRounds.java (modified) (5 diffs)
• ProgressTime.java (modified) (2 diffs)

timeline/src/main/java/geniusweb/progress/Progress.java

@@ -34 +34 @@
          *         eye on {@link #getTerminationTime()}.
          */
-        Double get(long currentTimeMs);
+        Double get(Long currentTimeMs);
 
         /**
@@ -51 +51 @@
          * @return true iff the progress has passed the deadline.
          */
-        boolean isPastDeadline(long currentTimeMs);
+        boolean isPastDeadline(Long currentTimeMs);
 }

timeline/src/main/java/geniusweb/progress/ProgressRounds.java

@@ -9 +9 @@
 /**
  * progress in terms of number of rounds. The round has to be updated by the
- * user of this class, calling {@link #advance()}.
+ * user of this class, calling {@link #advance()}. immutable.
  */
 @JsonTypeName("rounds")
@@ -49 +49 @@
         /**
          * 
-         * @return the current round. First round is 0. It is not recommended to use
-         *         this, as this may make your code working with rounds only.
+         * @return the current round. First round is 0. It is recommended that you
+         *         use the functions in {@link Progress} instead of this, to ensure
+         *         your code works with all implementations of Progress including
+         *         future developments.
          */
         public Integer getCurrentRound() {
@@ -58 +60 @@
         /**
          * 
-         * @return total number of rounds. It is not recommended to use this, as
-         *         this may make your code working with rounds only.
+         * @return total number of rounds. It is recommended that you use the
+         *         functions in {@link Progress} instead of this, to ensure your
+         *         code works with all implementations of Progress including future
+         *         developments.
          */
         public Integer getTotalRounds() {
@@ -66 +70 @@
 
         @Override
-        public Double get(long currentTimeMs) {
+        public Double get(Long currentTimeMs) {
                 // deadline and current both are limited to MAXINT is 32 bits; double
                 // fits 52
@@ -79 +83 @@
 
         @Override
-        public boolean isPastDeadline(long currentTimeMs) {
+        public boolean isPastDeadline(Long currentTimeMs) {
                 return currentRound >= duration || currentTimeMs > endtime.getTime();
         }

timeline/src/main/java/geniusweb/progress/ProgressTime.java

@@ -51 +51 @@
 
         @Override
-        public Double get(long currentTimeMs) {
+        public Double get(Long currentTimeMs) {
                 long delta = currentTimeMs - start.getTime();
                 // double should have ~53 digits of precision, and we're computing
@@ -66 +66 @@
 
         @Override
-        public boolean isPastDeadline(long currentTimeMs) {
+        public boolean isPastDeadline(Long currentTimeMs) {
                 return currentTimeMs > start.getTime() + duration;
         }