Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[LANG-1506] Allow a StopWatch to carry an optional message.

This commit is contained in:
Gary Gregory 2019-12-30 14:53:22 -05:00
parent a914a268ba
commit 5ac643368d
3 changed files with 131 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -88,6 +88,7 @@ The <action> type attribute can be add,update,fix,remove.
<action type="update" dev="ggregory" due-to="Peter Verhas">Functions Javadoc #466.</action>
<action issue="LANG-1503" type="add" dev="ggregory" due-to="XenoAmess, Gary Gregory">Add factory methods to Pair classes with Map.Entry input. #454.</action>
<action issue="LANG-1505" type="add" dev="ggregory" due-to="Gary Gregory">Add StopWatch convenience APIs to format times and create a simple instance.</action>
<action issue="LANG-1506" type="add" dev="ggregory" due-to="Gary Gregory">Allow a StopWatch to carry an optional message.</action>
</release>
<release version="3.9" date="2019-04-09" description="New features and bug fixes. Requires Java 8, supports Java 9, 10, 11.">

50
src/main/java/org/apache/commons/lang3/time/StopWatch.java
View File

@ -17,8 +17,11 @@
package org.apache.commons.lang3.time;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import org.apache.commons.lang3.StringUtils;
/**
* <p>
* {@code StopWatch} provides a convenient API for timings.
@ -184,6 +187,13 @@ public class StopWatch {
return sw;
}
/**
* A message for string presentation.
*
* @since 3.10
*/
private final String message;
/**
* The current running state of the StopWatch.
*/
@ -217,7 +227,18 @@ public class StopWatch {
* </p>
*/
public StopWatch() {
super();
this(null);
}
/**
* <p>
* Constructor.
* </p>
* @param message A message for string presentation.
* @since 3.10
*/
public StopWatch(final String message) {
this.message = message;
}
/**
@ -240,6 +261,16 @@ public class StopWatch {
return DurationFormatUtils.formatDurationHMS(getTime());
}
/**
* Gets the message for string presentation.
*
* @return the message for string presentation.
* @since 3.10
*/
public String getMessage() {
return message;
}
/**
* <p>
* Gets the time on the stopwatch in nanoseconds.
@ -264,7 +295,6 @@ public class StopWatch {
throw new RuntimeException("Illegal running state has occurred.");
}
/**
* <p>
* Gets the split time on the stopwatch in nanoseconds.
@ -409,7 +439,6 @@ public class StopWatch {
this.runningState = State.UNSTARTED;
this.splitState = SplitState.UNSPLIT;
}
/**
* <p>
* Resumes the stopwatch after a suspend.
@ -430,6 +459,7 @@ public class StopWatch {
this.startTime += System.nanoTime() - this.stopTime;
this.runningState = State.RUNNING;
}
/**
* <p>
* Splits the time.
@ -524,14 +554,17 @@ public class StopWatch {
* </p>
*
* <p>
* The format used is ISO 8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* The format used is ISO 8601-like, [<i>message</i> ]<i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* </p>
*
* @return the split time as a String
* @since 2.1
* @since 3.10 Returns the prefix {@code "message "} if the message is set.
*/
public String toSplitString() {
return DurationFormatUtils.formatDurationHMS(getSplitTime());
final String msgStr = Objects.toString(message, StringUtils.EMPTY);
final String formattedTime = formatSplitTime();
return msgStr.isEmpty() ? formattedTime : msgStr + StringUtils.SPACE + formattedTime;
}
/**
@ -540,14 +573,17 @@ public class StopWatch {
* </p>
*
* <p>
* The format used is ISO 8601-like, <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* The format used is ISO 8601-like, [<i>message</i> ]<i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.
* </p>
*
* @return the time as a String
* @since 3.10 Returns the prefix {@code "message "} if the message is set.
*/
@Override
public String toString() {
return DurationFormatUtils.formatDurationHMS(getTime());
final String msgStr = Objects.toString(message, StringUtils.EMPTY);
final String formattedTime = formatTime();
return msgStr.isEmpty() ? formattedTime : msgStr + StringUtils.SPACE + formattedTime;
}
/**

92
src/test/java/org/apache/commons/lang3/time/StopWatchTest.java
View File

@ -19,6 +19,7 @@ package org.apache.commons.lang3.time;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
@ -32,6 +33,11 @@ import org.junit.jupiter.api.Test;
*/
public class StopWatchTest {
private static final String MESSAGE = "Baking cookies";
private static final int MIN_SLEEP_MILLISECONDS = 20;
private static final String ZERO_HOURS_PREFIX = "00:";
private static final String ZERO_TIME_ELAPSED = "00:00:00.000";
/**
* <p>
* Creates a suspended StopWatch object which appears to have elapsed
@ -148,15 +154,37 @@ public class StopWatchTest {
@Test
public void testFormatSplitTime() throws InterruptedException {
final StopWatch watch = StopWatch.createStarted();
Thread.sleep(20);
Thread.sleep(MIN_SLEEP_MILLISECONDS);
watch.split();
assertNotEquals("00:00:00.000", watch.formatSplitTime());
final String formatSplitTime = watch.formatSplitTime();
assertNotEquals(ZERO_TIME_ELAPSED, formatSplitTime);
assertTrue(formatSplitTime.startsWith(ZERO_HOURS_PREFIX));
}
@Test
public void testFormatSplitTimeWithMessage() throws InterruptedException {
final StopWatch watch = new StopWatch(MESSAGE);
watch.start();
Thread.sleep(MIN_SLEEP_MILLISECONDS);
watch.split();
final String formatSplitTime = watch.formatSplitTime();
assertFalse(formatSplitTime.startsWith(MESSAGE), formatSplitTime);
assertTrue(formatSplitTime.startsWith(ZERO_HOURS_PREFIX));
}
@Test
public void testFormatTime() {
final StopWatch watch = StopWatch.create();
assertEquals("00:00:00.000", watch.formatTime());
final String formatTime = watch.formatTime();
assertEquals(ZERO_TIME_ELAPSED, formatTime);
assertTrue(formatTime.startsWith(ZERO_HOURS_PREFIX));
}
@Test
public void testFormatTimeWithMessage() {
final StopWatch watch = new StopWatch(MESSAGE);
final String formatTime = watch.formatTime();
assertFalse(formatTime.startsWith(MESSAGE), formatTime);
}
@Test
@ -199,6 +227,17 @@ public class StopWatchTest {
assertEquals(suspendTime, totalTime);
}
@Test
public void testMessage() {
assertNull(StopWatch.create().getMessage());
final StopWatch stopWatch = new StopWatch(MESSAGE);
assertEquals(MESSAGE, stopWatch.getMessage());
assertTrue(stopWatch.toString().startsWith(MESSAGE));
stopWatch.start();
stopWatch.split();
assertTrue(stopWatch.toSplitString().startsWith(MESSAGE));
}
@Test
public void testStopWatchGetWithTimeUnit() {
// Create a mock StopWatch with a time of 2:59:01.999
@ -214,7 +253,6 @@ public class StopWatchTest {
assertEquals(10741999L, watch.getTime(TimeUnit.MILLISECONDS));
}
//-----------------------------------------------------------------------
@Test
public void testStopWatchSimple() {
final StopWatch watch = StopWatch.createStarted();
@ -238,7 +276,7 @@ public class StopWatchTest {
public void testStopWatchSimpleGet() {
final StopWatch watch = new StopWatch();
assertEquals(0, watch.getTime());
assertEquals("00:00:00.000", watch.toString());
assertEquals(ZERO_TIME_ELAPSED, watch.toString());
watch.start();
try {
@ -329,4 +367,48 @@ public class StopWatchTest {
final String splitStr = watch.toSplitString();
assertEquals(splitStr.length(), 12, "Formatted split string not the correct length");
}
@Test
public void testToSplitStringWithMessage() {
final StopWatch watch = new StopWatch(MESSAGE);
watch.start();
try {
Thread.sleep(550);
} catch (final InterruptedException ex) {
// ignore
}
watch.split();
final String splitStr = watch.toSplitString();
assertEquals(splitStr.length(), 12 + MESSAGE.length() + 1, "Formatted split string not the correct length");
}
@Test
public void testToString() {
//
final StopWatch watch = StopWatch.createStarted();
try {
Thread.sleep(550);
} catch (final InterruptedException ex) {
// ignore
}
watch.split();
final String splitStr = watch.toString();
assertEquals(splitStr.length(), 12, "Formatted split string not the correct length");
}
@Test
public void testToStringWithMessage() {
assertTrue(new StopWatch(MESSAGE).toString().startsWith(MESSAGE));
//
final StopWatch watch = new StopWatch(MESSAGE);
watch.start();
try {
Thread.sleep(550);
} catch (final InterruptedException ex) {
// ignore
}
watch.split();
final String splitStr = watch.toString();
assertEquals(splitStr.length(), 12 + MESSAGE.length() + 1, "Formatted split string not the correct length");
}
}