You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jmeter.apache.org by fs...@apache.org on 2014/11/29 12:04:15 UTC
svn commit: r1642416 - in
/jmeter/trunk/src/components/org/apache/jmeter/visualizers: ./ backend/
Author: fschumacher
Date: Sat Nov 29 11:04:14 2014
New Revision: 1642416
URL: http://svn.apache.org/r1642416
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/components/org/apache/jmeter/visualizers/ModelListener.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/RequestPanel.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphChart.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphDataBean.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphLineBean.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/StatVisualizer.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/SummaryReport.java
jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/SamplerMetric.java
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/ModelListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ModelListener.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/ModelListener.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/ModelListener.java Sat Nov 29 11:04:14 2014
@@ -32,6 +32,11 @@ public interface ModelListener {
/**
* Informs the Visualizer that a message should be displayed.
+ *
+ * @param messageString
+ * The text to be displayed
+ * @param isError
+ * Flag whether this message represents an error
*/
void displayMessage(String messageString, boolean isError);
}
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/RequestPanel.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/RequestPanel.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/RequestPanel.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/RequestPanel.java Sat Nov 29 11:04:14 2014
@@ -102,7 +102,7 @@ public class RequestPanel {
/**
* Put SamplerResult in all request view
*
- * @param samplerResult
+ * @param samplerResult The {@link SampleResult} to be put in all {@link RequestView}s
*/
public void setSamplerResult(SampleResult samplerResult) {
for (RequestView requestView : listRequestView) {
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphChart.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphChart.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphChart.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphChart.java Sat Nov 29 11:04:14 2014
@@ -95,23 +95,30 @@ public class RespTimeGraphChart extends
protected float strokeWidth = 3.5f;
/**
- *
+ * Constructor
*/
public RespTimeGraphChart() {
super();
}
- /**
- * @param layout
- */
+ /**
+ * Constructor
+ *
+ * @param layout
+ * The {@link LayoutManager} to be used
+ */
public RespTimeGraphChart(LayoutManager layout) {
super(layout);
}
- /**
- * @param layout
- * @param isDoubleBuffered
- */
+ /**
+ * Constructor
+ *
+ * @param layout
+ * The {@link LayoutManager} to be used
+ * @param isDoubleBuffered
+ * Flag whether double buffering should be used
+ */
public RespTimeGraphChart(LayoutManager layout, boolean isDoubleBuffered) {
super(layout, isDoubleBuffered);
}
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphDataBean.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphDataBean.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphDataBean.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphDataBean.java Sat Nov 29 11:04:14 2014
@@ -19,6 +19,10 @@
package org.apache.jmeter.visualizers;
+/**
+ * Bean to hold timing information about samples
+ *
+ */
public class RespTimeGraphDataBean {
private long startTime;
@@ -28,9 +32,14 @@ public class RespTimeGraphDataBean {
private String samplerLabel;
/**
+ * Constructor
+ *
* @param startTime
+ * The start time of this Sample
* @param time
+ * The time elapsed for this sample
* @param samplerLabel
+ * The label for this sample
*/
public RespTimeGraphDataBean(long startTime, long time, String samplerLabel) {
super();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphLineBean.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphLineBean.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphLineBean.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/RespTimeGraphLineBean.java Sat Nov 29 11:04:14 2014
@@ -21,6 +21,9 @@ package org.apache.jmeter.visualizers;
import java.awt.Color;
+/**
+ * Bean to represent information about a graph line
+ */
public class RespTimeGraphLineBean {
private String label;
@@ -28,8 +31,8 @@ public class RespTimeGraphLineBean {
private Color lineColor;
/**
- * @param label
- * @param lineColor
+ * @param label The label for this line
+ * @param lineColor The {@link Color} for this line
*/
public RespTimeGraphLineBean(String label, Color lineColor) {
super();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/StatVisualizer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/StatVisualizer.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/StatVisualizer.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/StatVisualizer.java Sat Nov 29 11:04:14 2014
@@ -98,7 +98,10 @@ public class StatVisualizer extends Abst
init();
}
- /** @deprecated - only for use in testing */
+ /**
+ * @return <code>true</code> iff all functors can be found
+ * @deprecated - only for use in testing
+ * */
@Deprecated
public static boolean testFunctors(){
StatVisualizer instance = new StatVisualizer();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/SummaryReport.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/SummaryReport.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/SummaryReport.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/SummaryReport.java Sat Nov 29 11:04:14 2014
@@ -144,7 +144,10 @@ public class SummaryReport extends Abstr
init();
}
- /** @deprecated - only for use in testing */
+ /**
+ * @return <code>true</code> iff all functors can be found
+ * @deprecated - only for use in testing
+ * */
@Deprecated
public static boolean testFunctors(){
SummaryReport instance = new SummaryReport();
Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/SamplerMetric.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/SamplerMetric.java?rev=1642416&r1=1642415&r2=1642416&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/SamplerMetric.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/SamplerMetric.java Sat Nov 29 11:04:14 2014
@@ -41,8 +41,8 @@ public class SamplerMetric {
}
/**
- *
- * @param result SampleResult
+ * Add a {@link SampleResult} to be used in the statistics
+ * @param result {@link SampleResult} to be used
*/
public synchronized void add(SampleResult result) {
if(result.isSuccessful()) {
@@ -64,7 +64,7 @@ public class SamplerMetric {
}
/**
- * Reset metric except for percentile related datas
+ * Reset metric except for percentile related data
*/
public synchronized void resetForTimeInterval() {
// We don't clear stats as it will slide as per my understanding of
@@ -78,60 +78,85 @@ public class SamplerMetric {
}
/**
- * @return mean
+ * Get the arithmetic mean of the stored values
+ *
+ * @return The arithmetic mean of the stored values
*/
public double getMean() {
return stats.getMean();
}
/**
+ * Returns an estimate for the requested percentile of the stored values.
+ *
* @param percentile
- * @return
+ * the requested percentile (scaled from 0 - 100)
+ * @return Returns an estimate for the requested percentile of the stored
+ * values.
*/
public double getPercentile(double percentile) {
return stats.getPercentile(percentile);
}
/**
+ * Get the number of total requests for the current time slot
*
- * @return total request
+ * @return number of total requests
*/
public int getTotal() {
return success+failure;
}
/**
- * @return the success
+ * Get the number of successful requests for the current time slot
+ *
+ * @return number of successful requests
*/
public int getSuccess() {
return success;
}
/**
- * @return the failure
+ * Get the number of failed requests for the current time slot
+ *
+ * @return number of failed requests
*/
public int getFailure() {
return failure;
}
/**
- * @return the maxTime
+ * Get the maximal elapsed time for all requests
+ *
+ * @return the maximal elapsed time, or <code>0</code> if no requests have
+ * been added yet
*/
public long getMaxTime() {
return maxTime;
}
/**
- * @return the minTime
+ * Get the minimal elapsed time for all requests
+ *
+ * @return the minTime, or {@link Long#MAX_VALUE} if no requests have been
+ * added yet
*/
public long getMinTime() {
return minTime;
}
+ /**
+ * @return the max number of active threads for this test run, or
+ * <code>0</code> if no samples have been added yet
+ */
public int getMaxActiveThreads() {
return maxActiveThreads;
}
+ /**
+ * @return the min number of active threads for this test run, or
+ * {@link Integer#MAX_VALUE} if no samples have been added yet
+ */
public int getMinActiveThreads() {
return minActiveThreads;
}