svn commit: r1784119 - in /jmeter/trunk/src/core/org/apache/jmeter/engine: JMeterEngine.java StandardJMeterEngine.java

[pm...@apache.org]

Author: pmouawad
Date: Thu Feb 23 12:44:35 2017
New Revision: 1784119

URL: http://svn.apache.org/viewvc?rev=1784119&view=rev
Log:
Add javadocs to JMeterEngine
Add default method stopTest to interface 

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/engine/JMeterEngine.java
    jmeter/trunk/src/core/org/apache/jmeter/engine/StandardJMeterEngine.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/engine/JMeterEngine.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/engine/JMeterEngine.java?rev=1784119&r1=1784118&r2=1784119&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/engine/JMeterEngine.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/engine/JMeterEngine.java Thu Feb 23 12:44:35 2017
@@ -26,17 +26,48 @@ import org.apache.jorphan.collections.Ha
  * This interface is implemented by classes that can run JMeter tests.
  */
 public interface JMeterEngine {
+    /**
+     * Configure engine
+     * @param testPlan
+     */
     void configure(HashTree testPlan);
 
+    /**
+     * Runs the test
+     * @throws JMeterEngineException
+     */
     void runTest() throws JMeterEngineException;
 
+    /**
+     * Stop test immediately interrupting current samplers
+     */
+    default void stopTest() {
+        stopTest(true);
+    }
+    /**
+     * 
+     * @param now boolean that tell wether stop is immediate (interrupt) or not (wait for current sample end)
+     */
     void stopTest(boolean now);
 
+    /**
+     * Stop test if running
+     */
     void reset();
 
+    /**
+     * set Properties on engine
+     * @param p
+     */
     void setProperties(Properties p);
 
+    /**
+     * Exit engine
+     */
     void exit();
     
+    /**
+     * @return boolean Flag to show whether engine is active (true when test is running). Set to false at end of test
+     */
     boolean isActive();
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/engine/StandardJMeterEngine.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/engine/StandardJMeterEngine.java?rev=1784119&r1=1784118&r2=1784119&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/engine/StandardJMeterEngine.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/engine/StandardJMeterEngine.java Thu Feb 23 12:44:35 2017
@@ -239,7 +239,7 @@ public class StandardJMeterEngine implem
             log.info("Test has ended on host "+host);
             long now=System.currentTimeMillis();
             System.out.println("Finished the test on host " + host + " @ "+new Date(now)+" ("+now+")" // NOSONAR Intentional
-            +(EXIT_AFTER_TEST ? " - exit requested." : ""));
+                    +(EXIT_AFTER_TEST ? " - exit requested." : ""));
             if (EXIT_AFTER_TEST){
                 exit();
             }
@@ -254,6 +254,10 @@ public class StandardJMeterEngine implem
         }
     }
 
+    /**
+     * Stop Test Now
+     */
+    @Override
     public synchronized void stopTest() {
         stopTest(true);
     }