changeset 970:a2f6cce2c08a

runners: declare Runner to be usable only once.
author shade
date Wed, 20 Aug 2014 12:58:53 +0400
parents b9151815e306
children 4a845244cdfc
files jmh-core/src/main/java/org/openjdk/jmh/runner/Runner.java
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-core/src/main/java/org/openjdk/jmh/runner/Runner.java	Wed Aug 20 12:47:56 2014 +0400
+++ b/jmh-core/src/main/java/org/openjdk/jmh/runner/Runner.java	Wed Aug 20 12:58:53 2014 +0400
@@ -71,6 +71,10 @@
  * Runner executes JMH benchmarks.
  *
  * <p>This is the entry point for JMH Java API.</p>
+ *
+ * <p>{@link Runner} is not usually reusable. After you execute any method on the {@link Runner}, you should digest
+ * the results, give up on current {@link Runner}, and instantiate another one. This class may be turned into
+ * static class in future releases.</p>
  */
 public class Runner extends BaseRunner {
     private final BenchmarkList list;