Javadoc

Author: garydgregory

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

@@ -60,7 +60,7 @@
  * </ol>
  *
  * <p>
- * This class is not thread-safe
+ * This class is not thread-safe.
  * </p>
  *
  * @see DurationUtils#of(FailableRunnable)
@@ -359,7 +359,7 @@ public long getNanoTime() {
      * This is the Duration between start and latest split.
      * </p>
      *
-     * @return the split Duration
+     * @return the split Duration.
      * @throws IllegalStateException if this StopWatch has not yet been split.
      * @since 3.16.0
      */
@@ -374,7 +374,7 @@ public Duration getSplitDuration() {
      * This is the time between start and latest split.
      * </p>
      *
-     * @return the split time in nanoseconds
+     * @return the split time in nanoseconds.
      * @throws IllegalStateException if this StopWatch has not yet been split.
      * @since 3.0
      */
@@ -392,7 +392,7 @@ public long getSplitNanoTime() {
      * This is the time between start and latest split.
      * </p>
      *
-     * @return the split time in milliseconds
+     * @return the split time in milliseconds.
      * @throws IllegalStateException if this StopWatch has not yet been split.
      * @since 2.1
      * @deprecated Use {@link #getSplitDuration()}.
@@ -406,7 +406,7 @@ public long getSplitTime() {
      * Gets the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC.
      *
      * @return the Instant this StopWatch was started, between the current time and midnight, January 1, 1970 UTC.
-     * @throws IllegalStateException if this StopWatch has not been started
+     * @throws IllegalStateException if this StopWatch has not been started.
      * @since 3.16.0
      */
     public Instant getStartInstant() {
@@ -420,7 +420,7 @@ public Instant getStartInstant() {
      * Gets the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC.
      *
      * @return the time this StopWatch was started in milliseconds, between the current time and midnight, January 1, 1970 UTC.
-     * @throws IllegalStateException if this StopWatch has not been started
+     * @throws IllegalStateException if this StopWatch has not been started.
      * @since 2.4
      * @deprecated Use {@link #getStartInstant()}.
      */
@@ -433,7 +433,7 @@ public long getStartTime() {
      * Gets the Instant this StopWatch was stopped, between the current time and midnight, January 1, 1970 UTC.
      *
      * @return the Instant this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.
-     * @throws IllegalStateException if this StopWatch has not been started
+     * @throws IllegalStateException if this StopWatch has not been started.
      * @since 3.16.0
      */
     public Instant getStopInstant() {
@@ -447,7 +447,7 @@ public Instant getStopInstant() {
      * Gets the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.
      *
      * @return the time this StopWatch was stopped in milliseconds, between the current time and midnight, January 1, 1970 UTC.
-     * @throws IllegalStateException if this StopWatch has not been started
+     * @throws IllegalStateException if this StopWatch has not been started.
      * @since 3.12.0
      * @deprecated Use {@link #getStopInstant()}.
      */
@@ -483,7 +483,7 @@ public <T, E extends Throwable> T getT(final FailableSupplier<T, E> supplier) th
      * This is either the time between the start and the moment this method is called, or the amount of time between start and stop.
      * </p>
      *
-     * @return the time in milliseconds
+     * @return the time in milliseconds.
      * @see #getDuration()
      */
     public long getTime() {
@@ -499,8 +499,8 @@ public long getTime() {
      * is 59 minutes, then the result returned will be {@code 0}.
      * </p>
      *
-     * @param timeUnit the unit of time, not null
-     * @return the time in the specified TimeUnit, rounded down
+     * @param timeUnit the unit of time, not null.
+     * @return the time in the specified TimeUnit, rounded down.
      * @since 3.5
      */
     public long getTime(final TimeUnit timeUnit) {
@@ -703,7 +703,7 @@ public void suspend() {
      * The format used is ISO 8601-like, [<em>message</em> ]<em>hours</em>:<em>minutes</em>:<em>seconds</em>.<em>milliseconds</em>.
      * </p>
      *
-     * @return the split time as a String
+     * @return the split time as a String.
      * @since 2.1
      * @since 3.10 Returns the prefix {@code "message "} if the message is set.
      */
@@ -720,7 +720,7 @@ public String toSplitString() {
      * The format used is ISO 8601-like, [<em>message</em> ]<em>hours</em>:<em>minutes</em>:<em>seconds</em>.<em>milliseconds</em>.
      * </p>
      *
-     * @return the time as a String
+     * @return the time as a String.
      * @since 3.10 Returns the prefix {@code "message "} if the message is set.
      */
     @Override