jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1647786 - in /jmeter/trunk/src/core/org/apache/jmeter: testelement/ testelement/property/ threads/
Date Wed, 24 Dec 2014 13:58:12 GMT
Author: fschumacher
Date: Wed Dec 24 13:58:11 2014
New Revision: 1647786

URL: http://svn.apache.org/r1647786
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/TestPlan.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/WorkBench.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/MultiProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NullProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/ObjectProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/AbstractThreadGroup.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterThread.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListenerImpl.java
    jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElement.java Wed Dec 24 13:58:11
2014
@@ -19,6 +19,7 @@
 package org.apache.jmeter.testelement;
 
 import org.apache.jmeter.testelement.property.JMeterProperty;
+import org.apache.jmeter.testelement.property.NullProperty;
 import org.apache.jmeter.testelement.property.PropertyIterator;
 import org.apache.jmeter.threads.JMeterContext;
 
@@ -75,6 +76,8 @@ public interface TestElement extends Clo
 
     /**
      * Returns true or false whether the element is the running version.
+     * 
+     * @return <code>true</code> if the element is the running version
      */
     boolean isRunningVersion();
 
@@ -98,21 +101,86 @@ public interface TestElement extends Clo
 
     /**
      * Return a property as a boolean value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
      */
     boolean getPropertyAsBoolean(String key);
 
+    /**
+     * Return a property as a boolean value or a default value if no property
+     * could be found.
+     *
+     * @param key
+     *            the name of the property to get
+     * @param defaultValue
+     *            the default value to use
+     * @return the value of the property, or <code>defaultValue</code> if no
+     *         property could be found
+     */
     boolean getPropertyAsBoolean(String key, boolean defaultValue);
 
+    /**
+     * Return a property as a long value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
+     */
     long getPropertyAsLong(String key);
 
+    /**
+     * Return a property as a long value or a default value if no property
+     * could be found.
+     *
+     * @param key
+     *            the name of the property to get
+     * @param defaultValue
+     *            the default value to use
+     * @return the value of the property, or <code>defaultValue</code> if no
+     *         property could be found
+     */
     long getPropertyAsLong(String key, long defaultValue);
 
+    /**
+     * Return a property as an int value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
+     */
     int getPropertyAsInt(String key);
-
+    
+    /**
+     * Return a property as an int value or a default value if no property
+     * could be found.
+     *
+     * @param key
+     *            the name of the property to get
+     * @param defaultValue
+     *            the default value to use
+     * @return the value of the property, or <code>defaultValue</code> if no
+     *         property could be found
+     */
     int getPropertyAsInt(String key, int defaultValue);
 
+    /**
+     * Return a property as a float value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
+     */
     float getPropertyAsFloat(String key);
 
+    /**
+     * Return a property as a double value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
+     */
     double getPropertyAsDouble(String key);
 
     /**
@@ -122,6 +190,9 @@ public interface TestElement extends Clo
      * making the TestElement Read- Only, but not as strict. Changes can be made
      * and the element can be modified, but the state of the element at the time
      * of the call to setRunningVersion() must be recoverable.
+     *
+     * @param run
+     *            flag whether this element should be the running version
      */
     void setRunningVersion(boolean run);
 
@@ -138,19 +209,45 @@ public interface TestElement extends Clo
     // TODO - yet another ambiguous name - does it need changing?
     // See also: Clearable, JMeterGUIComponent
 
+    /**
+     * Return a property as a string value.
+     *
+     * @param key
+     *            the name of the property to get
+     * @return the value of the property
+     */
     String getPropertyAsString(String key);
 
+    /**
+     * Return a property as an string value or a default value if no property
+     * could be found.
+     *
+     * @param key
+     *            the name of the property to get
+     * @param defaultValue
+     *            the default value to use
+     * @return the value of the property, or <code>defaultValue</code> if no
+     *         property could be found
+     */
     String getPropertyAsString(String key, String defaultValue);
 
     /**
      * Sets and overwrites a property in the TestElement. This call will be
      * ignored if the TestElement is currently a "running version".
+     *
+     * @param property
+     *            the property to be set
      */
     void setProperty(JMeterProperty property);
 
     /**
      * Given the name of the property, returns the appropriate property from
      * JMeter. If it is null, a NullProperty object will be returned.
+     *
+     * @param propName
+     *            the name of the property to get
+     * @return {@link JMeterProperty} stored under the name, or
+     *         {@link NullProperty} if no property can be found
      */
     JMeterProperty getProperty(String propName);
 
@@ -161,6 +258,12 @@ public interface TestElement extends Clo
      */
     PropertyIterator propertyIterator();
 
+    /**
+     * Remove property stored under the <code>key</code>
+     *
+     * @param key
+     *            name of the property to be removed
+     */
     void removeProperty(String key);
 
     // lifecycle methods
@@ -169,6 +272,9 @@ public interface TestElement extends Clo
 
     /**
      * Convenient way to traverse a test element.
+     *
+     * @param traverser
+     *            The traverser that is notified of the contained elements
      */
     void traverse(TestElementTraverser traverser);
 
@@ -203,11 +309,28 @@ public interface TestElement extends Clo
      */
     boolean canRemove();
 
+    /**
+     * Get the name of this test element
+     * @return name of this element
+     */
     String getName();
 
+    /**
+     * @param name
+     *            of this element
+     */
     void setName(String name);
 
+    /**
+     * @return comment associated with this element
+     */
     String getComment();
 
+    /**
+     * Associates a comment with this element
+     *
+     * @param comment
+     *            to be associated
+     */
     void setComment(String comment);
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/TestPlan.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/TestPlan.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/TestPlan.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/TestPlan.java Wed Dec 24 13:58:11
2014
@@ -156,8 +156,12 @@ public class TestPlan extends AbstractTe
     }
 
     /**
-     * Set the classpath for the test plan
+     * Set the classpath for the test plan. If the classpath is made up from
+     * more then one path, the parts must be separated with
+     * {@link TestPlan#CLASSPATH_SEPARATOR}.
+     *
      * @param text
+     *            the classpath to be set
      */
     public void setTestPlanClasspath(String text) {
         setProperty(CLASSPATHS,text);

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/WorkBench.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/WorkBench.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/WorkBench.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/WorkBench.java Wed Dec 24 13:58:11
2014
@@ -29,6 +29,8 @@ public class WorkBench extends AbstractT
 
     /**
      * Constructor for the WorkBench object.
+     * @param name the name of this element
+     * @param isRootNode IGNORED
      */
     public WorkBench(String name, boolean isRootNode) {
         setName(name);

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java Wed Dec
24 13:58:11 2014
@@ -61,6 +61,8 @@ public interface JMeterProperty extends
     /**
      * Tell the property to revert to the state at the time
      * setRunningVersion(true) was called.
+     *
+     * @param owner the owning element
      */
     void recoverRunningVersion(TestElement owner);
 

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/MultiProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/MultiProperty.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/MultiProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/MultiProperty.java Wed Dec
24 13:58:11 2014
@@ -47,6 +47,8 @@ public abstract class MultiProperty exte
 
     /**
      * Add a property to the collection.
+     *
+     * @param prop the {@link JMeterProperty} to add
      */
     public abstract void addProperty(JMeterProperty prop);
 

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NullProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NullProperty.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NullProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/NullProperty.java Wed Dec
24 13:58:11 2014
@@ -71,6 +71,9 @@ public final class NullProperty extends
 
     /**
      * see JMeterProperty#isTemporary(TestElement)
+     * <p>TODO seems to be a relic from the past.
+     * @param owner IGNORED
+     * @return always <code>true</code>
      */
     public boolean isTemporary(TestElement owner) {
         return true;

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/ObjectProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/ObjectProperty.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/ObjectProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/ObjectProperty.java Wed Dec
24 13:58:11 2014
@@ -64,7 +64,8 @@ public class ObjectProperty extends Abst
     }
 
     /**
-     *
+     * Default constructor. Constructs an {@link ObjectProperty} with no name
+     * and a <code>null</code> value
      */
     public ObjectProperty() {
         super();
@@ -72,12 +73,25 @@ public class ObjectProperty extends Abst
     }
 
     /**
+     * Constructs an instance with <code>name</code> as its name and a
+     * <code>null</code> value.
+     *
      * @param name
+     *            the name of this property
      */
     public ObjectProperty(String name) {
         super(name);
     }
 
+    /**
+     * Constructs an instance with <code>name</code> as its name and the giveN
+     * value.
+     *
+     * @param name
+     *            the name of this property
+     * @param p
+     *            the value for this property
+     */
     public ObjectProperty(String name, Object p) {
         super(name);
         value = p;

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/AbstractThreadGroup.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/AbstractThreadGroup.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/AbstractThreadGroup.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/AbstractThreadGroup.java Wed Dec 24 13:58:11
2014
@@ -194,6 +194,8 @@ public abstract class AbstractThreadGrou
 
     /**
      * Get the number of active threads
+     *
+     * @return the number of active threads
      */
     public int getNumberOfThreads() {
         return numberOfThreads.get();

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterContext.java Wed Dec 24 13:58:11
2014
@@ -164,8 +164,10 @@ public class JMeterContext {
     }
 
     /**
-     * if set to true a restart of the loop will occurs
+     * if set to <code>true</code> a restart of the loop will occurs
+     *
      * @param restartNextLoop
+     *            flag whether restart will occur
      */
     public void setRestartNextLoop(boolean restartNextLoop) {
         this.restartNextLoop = restartNextLoop;

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterThread.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterThread.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterThread.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/JMeterThread.java Wed Dec 24 13:58:11
2014
@@ -153,6 +153,9 @@ public class JMeterThread implements Run
 
     /**
      * Enable the scheduler for this JMeterThread.
+     *
+     * @param sche
+     *            flag whether the scheduler should be enabled
      */
     public void setScheduled(boolean sche) {
         this.scheduler = sche;
@@ -839,6 +842,8 @@ public class JMeterThread implements Run
 
     /**
      * Returns the threadNum.
+     *
+     * @return the threadNum
      */
     public int getThreadNum() {
         return threadNum;
@@ -867,7 +872,7 @@ public class JMeterThread implements Run
     /**
      * Save the engine instance for access to the stop methods
      *
-     * @param engine
+     * @param engine the engine which is used
      */
     public void setEngine(StandardJMeterEngine engine) {
         this.engine = engine;

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListener.java Wed Dec 24
13:58:11 2014
@@ -33,7 +33,8 @@ public interface RemoteThreadsListener e
     void threadStarted() throws RemoteException;
 
     /**
-     * @see org.apache.jmeter.testelement.ThreadListener#threadStarted()
+     * @see org.apache.jmeter.testelement.ThreadListener#threadFinished()
+     * @throws RemoteException
      */
     void threadFinished() throws RemoteException;
 }

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListenerImpl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListenerImpl.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListenerImpl.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/RemoteThreadsListenerImpl.java Wed Dec
24 13:58:11 2014
@@ -52,7 +52,7 @@ public class RemoteThreadsListenerImpl e
             JMeterUtils.getPropDefault("client.rmi.localport", 0); // $NON-NLS-1$
 
     /**
-     * @throws RemoteException
+     * @throws RemoteException if failed to export object
      */
     public RemoteThreadsListenerImpl() throws RemoteException {
         super(DEFAULT_LOCAL_PORT);

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java?rev=1647786&r1=1647785&r2=1647786&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java Wed Dec 24 13:58:11
2014
@@ -128,7 +128,7 @@ public class TestCompiler implements Has
 
     /**
      * Reset pack to its initial state
-     * @param pack
+     * @param pack the {@link SamplePackage} to reset
      */
     public void done(SamplePackage pack) {
         pack.recoverRunningVersion();



Mime
View raw message