Author: sebb
Date: Tue Nov 20 08:00:49 2007
New Revision: 596725
URL: http://svn.apache.org/viewvc?rev=596725&view=rev
Log:
Javadoc fixups
Modified:
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/XMLDefaultMutableTreeNode.java
jakarta/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
jakarta/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
jakarta/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/ComboStringEditor.java
jakarta/jmeter/trunk/src/core/org/apache/jmeter/util/StringUtilities.java
jakarta/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/Functor.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/XMLBuffer.java
jakarta/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorModel.java
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ConnectionFactory.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/OnMessageSubscriber.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryDialoger.java
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/DataSet.java
Modified:
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
(original)
+++
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/LineGraph.java
Tue Nov 20 08:00:49 2007
@@ -179,7 +179,7 @@
* Since we only have 4 shapes, the method will start with the
* first shape and keep cycling through the shapes in order.
* @param count
- * @return
+ * @return the first n shapes
*/
public Shape[] createShapes(int count) {
Shape[] shapes = new Shape[count];
@@ -191,7 +191,7 @@
/**
* Return the next shape
- * @return
+ * @return the next shape
*/
public Shape nextShape() {
this.shape_counter++;
@@ -204,7 +204,7 @@
/**
*
* @param count
- * @return
+ * @return the first count strokes
*/
public Stroke[] createStrokes(int count) {
Stroke[] str = new Stroke[count];
@@ -216,7 +216,7 @@
/**
* method always return a new BasicStroke with 1.0f weight
- * @return
+ * @return a new BasicStroke with 1.0f weight
*/
public Stroke nextStroke() {
return new BasicStroke(1.0f);
@@ -227,7 +227,7 @@
* implementation will cycle through 12 colors if a line graph
* has more than 12 entries
* @param count
- * @return
+ * @return an array of Paint with different colors
*/
public Paint[] createPaint(int count) {
Paint[] pts = new Paint[count];
@@ -242,7 +242,7 @@
* Rather than return a random color, we want it to always go through
* the same sequence. This way, the same charts will always use the
* same color and make it easier to compare side by side.
- * @return
+ * @return the next paint color in the PAINT_ARRAY
*/
public Paint nextPaint() {
this.paint_counter++;
Modified:
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java
(original)
+++
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/ViewResultsFullVisualizer.java
Tue Nov 20 08:00:49 2007
@@ -1095,7 +1095,7 @@
/**
* get the JOptionPaneMessage Type
*
- * @return
+ * @return the message type
*/
public int getMessageType() {
return messageType;
@@ -1104,7 +1104,7 @@
/**
* get error message
*
- * @return
+ * @return the error message
*/
public String getErrorMessage() {
return msg;
Modified:
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/XMLDefaultMutableTreeNode.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/XMLDefaultMutableTreeNode.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/XMLDefaultMutableTreeNode.java
(original)
+++
jakarta/jmeter/trunk/src/components/org/apache/jmeter/visualizers/XMLDefaultMutableTreeNode.java
Tue Nov 20 08:00:49 2007
@@ -33,8 +33,7 @@
/**
* A extended class of DefaultMutableTreeNode except that it also attached XML
- * node and convert XML document into DefaultMutableTreeNode author <a
- * href="mailto:[EMAIL PROTECTED]">Dave Maung</a>
+ * node and convert XML document into DefaultMutableTreeNode.
*
*/
public class XMLDefaultMutableTreeNode extends DefaultMutableTreeNode {
@@ -199,7 +198,7 @@
/**
* get the xml node
*
- * @return
+ * @return the XML node
*/
public Node getXMLNode() {
return xmlNode;
Modified:
jakarta/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
(original)
+++
jakarta/jmeter/trunk/src/core/org/apache/jmeter/save/SaveGraphicsService.java
Tue Nov 20 08:00:49 2007
@@ -174,7 +174,7 @@
* we shouldn't get a FNFE.
*
* @param filename
- * @return
+ * @return output stream created from the filename
*/
public FileOutputStream createFile(File filename) {
try {
Modified:
jakarta/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
(original)
+++ jakarta/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
Tue Nov 20 08:00:49 2007
@@ -42,7 +42,6 @@
import org.apache.log.Logger;
/**
- * @author mstover
*
* The point of this class is to provide thread-safe access to files, and to
* provide some simplifying assumptions about where to find files and how to
@@ -260,7 +259,7 @@
* File access relative to current test's base directory.
*
* @param basedir
- * @return
+ * @return a random File from the basedir that matches one of the
extensions
*/
public File getRandomFile(String basedir, String[] extensions) {
File input = null;
Modified:
jakarta/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/ComboStringEditor.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/ComboStringEditor.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/ComboStringEditor.java
(original)
+++
jakarta/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/ComboStringEditor.java
Tue Nov 20 08:00:49 2007
@@ -42,7 +42,6 @@
* property is set.
* </ul>
*
- * @author <a href="mailto:[EMAIL PROTECTED]">Jordi Salvat i Alabart</a>
*/
class ComboStringEditor extends PropertyEditorSupport implements ItemListener {
@@ -205,30 +204,18 @@
textField.selectAll();
}
- /**
- * @return
- */
public String getInitialEditValue() {
return initialEditValue;
}
- /**
- * @return
- */
public boolean getNoEdit() {
return noEdit;
}
- /**
- * @return
- */
public boolean getNoUndefined() {
return noUndefined;
}
- /**
- * @return
- */
public String[] getTags() {
return tags;
}
Modified:
jakarta/jmeter/trunk/src/core/org/apache/jmeter/util/StringUtilities.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/core/org/apache/jmeter/util/StringUtilities.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/core/org/apache/jmeter/util/StringUtilities.java
(original)
+++ jakarta/jmeter/trunk/src/core/org/apache/jmeter/util/StringUtilities.java
Tue Nov 20 08:00:49 2007
@@ -18,9 +18,6 @@
package org.apache.jmeter.util;
-/**
- * @version $Revision$
- */
public final class StringUtilities {
/**
@@ -32,7 +29,7 @@
/**
* Replace all patterns in a String
*
- * @see String.replaceAll(String,String)
+ * @see String#replaceAll(String,String)
* - JDK1.4 only
*
* @param input - string to be transformed
Modified:
jakarta/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java
(original)
+++
jakarta/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java
Tue Nov 20 08:00:49 2007
@@ -83,7 +83,7 @@
*
* @param file
* @param xpathString
- * @return
+ * @return the next row from the file container
*/
public static String getXPathString(String file, String xpathString) {
Map my = (Map) filePacks.get();
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
(original)
+++
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/AbstractTreeTableModel.java
Tue Nov 20 08:00:49 2007
@@ -29,10 +29,6 @@
import org.apache.jorphan.reflect.Functor;
-/**
- * @author Peter Lin
- *
- */
public abstract class AbstractTreeTableModel extends DefaultTableModel
implements TreeTableModel {
protected TreeNode rootNode = null;
@@ -68,7 +64,7 @@
/**
* The root node for the TreeTable
- * @return
+ * @return the root node
*/
public Object getRootNode() {
return this.rootNode;
@@ -157,7 +153,7 @@
* the implementation checks if the Object is a treenode. If it is,
* it returns isLeaf(), otherwise it returns false.
* @param node
- * @return
+ * @return whether object is a leaf node or not
*/
public boolean isLeaf(Object node) {
if (node instanceof TreeNode) {
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
(original)
+++ jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/TreeTableModel.java
Tue Nov 20 08:00:49 2007
@@ -21,7 +21,6 @@
import javax.swing.table.TableModel;
/**
- * @author Peter Lin
*
* This is a basic interface for TreeTableModel that extends TableModel.
* It's pretty minimal and isn't as full featured at other implementations.
@@ -33,7 +32,7 @@
* the row is an object.
* @param node
* @param col
- * @return
+ * @return the value at the column
*/
public Object getValueAt(Object node, int col);
@@ -42,7 +41,7 @@
* the row is an object.
* @param node
* @param col
- * @return
+ * @return if cell is editable
*/
public boolean isCellEditable(Object node, int col);
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
(original)
+++ jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassTools.java
Tue Nov 20 08:00:49 2007
@@ -34,8 +34,8 @@
* Call no-args constructor for a class.
*
* @param className
- * @return
- * @throws JMeterException
+ * @return an instance of the class
+ * @throws JMeterException if class cannot be created
*/
public static Object construct(String className) throws JMeterException
{
Object instance = null;
@@ -52,11 +52,11 @@
}
/**
- * Call a class constructor
+ * Call a class constructor with an integer parameter
* @param className
* @param parameter (integer)
- * @return
- * @throws JMeterException
+ * @return an instance of the class
+ * @throws JMeterException if class cannot be created
*/
public static Object construct(String className, int parameter) throws
JMeterException
{
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/Functor.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/Functor.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/Functor.java
(original)
+++ jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/Functor.java
Tue Nov 20 08:00:49 2007
@@ -130,7 +130,7 @@
*
* @param _invokee object on which to invoke the method
* @param _methodName method name
- * @param types
+ * @param _types
*/
public Functor(Object _invokee, String _methodName, Class[] _types) {
this(null, _invokee, _methodName, null, _types);
@@ -143,7 +143,7 @@
*
* @param _clazz the class in which to find the method
* @param _methodName method name
- * @param types
+ * @param _types
*/
public Functor(Class _clazz, String _methodName, Class[] _types) {
this(_clazz, null, _methodName, null, _types);
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
(original)
+++ jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/JOrphanUtils.java
Tue Nov 20 08:00:49 2007
@@ -33,8 +33,6 @@
/**
* This class contains frequently-used static utility methods.
*
- * author <a href="mailto://[EMAIL PROTECTED]">Jordi Salvat i Alabart</a>
- * Created 27th December 2002
*/
public final class JOrphanUtils {
@@ -295,7 +293,7 @@
/**
* Replace all patterns in a String
*
- * @see String.replaceAll(regex,replacement) - JDK1.4 only
+ * @see String#replaceAll(String regex,String replacement) - JDK1.4 only
*
* @param input - string to be transformed
* @param pattern - pattern to replace
Modified:
jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/XMLBuffer.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/XMLBuffer.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/XMLBuffer.java
(original)
+++ jakarta/jmeter/trunk/src/jorphan/org/apache/jorphan/util/XMLBuffer.java Tue
Nov 20 08:00:49 2007
@@ -82,7 +82,7 @@
*
* @param tagname
* @param content
- * @return
+ * @return this
*/
public XMLBuffer tag(String tagname,String content){
startTag(tagname);
@@ -96,7 +96,7 @@
*
* @param tagname
* @param content
- * @return
+ * @return this
*/
public XMLBuffer tag(String tagname,StringBuffer content){
startTag(tagname);
Modified:
jakarta/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
(original)
+++
jakarta/jmeter/trunk/src/junit/org/apache/jmeter/protocol/java/sampler/JUnitSampler.java
Tue Nov 20 08:00:49 2007
@@ -37,7 +37,6 @@
import org.apache.log.Logger;
/**
- * @author pete
*
* This is a basic implementation that runs a single test method of
* a JUnit test case. The current implementation will use the string
@@ -133,7 +132,6 @@
/**
* get the string passed to the string constructor
- * @return
*/
public String getConstructorString()
{
@@ -142,7 +140,6 @@
/**
* Return the name of the method to test
- * @return
*/
public String getMethod(){
return getPropertyAsString(METHOD);
@@ -159,7 +156,6 @@
/**
* get the success message
- * @return
*/
public String getSuccess(){
return getPropertyAsString(SUCCESS);
@@ -175,7 +171,6 @@
/**
* get the success code defined by the user
- * @return
*/
public String getSuccessCode(){
return getPropertyAsString(SUCCESSCODE);
@@ -192,7 +187,6 @@
/**
* get the failure message
- * @return
*/
public String getFailure(){
return getPropertyAsString(FAILURE);
@@ -208,7 +202,6 @@
/**
* The failure code is used by other components
- * @return
*/
public String getFailureCode(){
return getPropertyAsString(FAILURECODE);
@@ -224,7 +217,6 @@
/**
* return the descriptive error for the test
- * @return
*/
public String getError(){
return getPropertyAsString(ERROR);
@@ -244,7 +236,6 @@
/**
* return the error code for the test method. it should
* be an unique error code.
- * @return
*/
public String getErrorCode(){
return getPropertyAsString(ERRORCODE);
@@ -261,7 +252,6 @@
/**
* return the comma separated string for the filter
- * @return
*/
public String getFilterString(){
return getPropertyAsString(FILTER);
@@ -279,7 +269,6 @@
* if the sample shouldn't call setup/teardown, the
* method returns true. It's meant for onetimesetup
* and onetimeteardown.
- * @return
*/
public boolean getDoNotSetUpTearDown(){
return getPropertyAsBoolean(DOSETUP);
@@ -298,7 +287,6 @@
* which means users have to explicitly set the sampler to
* append the assert errors. Because of how junit works, there
* should only be one error
- * @return
*/
public boolean getAppendError() {
return getPropertyAsBoolean(APPEND_ERROR,false);
@@ -312,7 +300,6 @@
* If append exception is not set, by default it is set to false.
* Users have to explicitly set it to true to see the exceptions
* in the result tree.
- * @return
*/
public boolean getAppendException() {
return getPropertyAsBoolean(APPEND_EXCEPTION,false);
@@ -458,7 +445,6 @@
* If the method is not able to create a new instance of the
* class, it returns null and logs all the exceptions at
* warning level.
- * @return
*/
public static Object getClassInstance(String className, String label){
Object testclass = null;
@@ -531,7 +517,7 @@
*
* @param clazz
* @param method
- * @return
+ * @return the method or null if an error occurred
*/
public Method getMethod(Object clazz, String method){
if (clazz != null && method != null){
Modified:
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
(original)
+++
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorAccumModel.java
Tue Nov 20 08:00:49 2007
@@ -68,7 +68,7 @@
/**
* Added this method we that we can save the calculated stats.
*
- * @return
+ * @return current sample
*/
public MonitorModel getLastSample() {
return this.CURRENT;
Modified:
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorModel.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorModel.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorModel.java
(original)
+++
jakarta/jmeter/trunk/src/monitor/components/org/apache/jmeter/visualizers/MonitorModel.java
Tue Nov 20 08:00:49 2007
@@ -144,7 +144,7 @@
/**
* a clone method to clone the stats
*
- * @return
+ * @return new instance of the class
*/
public MonitorStats cloneMonitorStats() {
return new MonitorStats(current.getHealth(), current.getLoad(),
current.getCpuLoad(), current.getMemLoad(),
Modified:
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java
Tue Nov 20 08:00:49 2007
@@ -299,7 +299,7 @@
/**
* method returns the WSDL URL
*
- * @return
+ * @return the WSDL URL
*/
public String getWsdlURL() {
return getPropertyAsString(WSDL_URL);
Modified:
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
Tue Nov 20 08:00:49 2007
@@ -100,7 +100,6 @@
/**
* Return the protocol from the URL. this is needed, so that HTTPS works
* as expected.
- * @return
*/
public String getProtocol() {
return this.bindingURL.getProtocol();
@@ -108,7 +107,6 @@
/**
* Return the host in the WSDL binding address
- * @return
*/
public String getBindingHost() {
return this.bindingURL.getHost();
@@ -116,7 +114,6 @@
/**
* Return the path in the WSDL for the binding address
- * @return
*/
public String getBindingPath() {
return this.bindingURL.getPath();
@@ -124,7 +121,6 @@
/**
* Return the port for the binding address
- * @return
*/
public int getBindingPort() {
return this.bindingURL.getPort();
Modified:
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
Tue Nov 20 08:00:49 2007
@@ -70,8 +70,6 @@
* IIS and Netscape.
* <p>
*
- * @version $Revision$ last updated $Date$ Created
- * on: June 23, 2003<br>
*/
public class TCLogParser implements LogParser {
@@ -107,7 +105,7 @@
*/
protected boolean decode = true;
- // TODO downcase UPPER case variables
+ // TODO downcase UPPER case non-final variables
/**
*
@@ -134,7 +132,7 @@
/**
* decode the parameter values is to true by default
- * @return
+ * @return if paramter values should be decoded
*/
public boolean decodeParameterValue() {
return this.decode;
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ConnectionFactory.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ConnectionFactory.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ConnectionFactory.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ConnectionFactory.java
Tue Nov 20 08:00:49 2007
@@ -34,7 +34,6 @@
import org.apache.log.Logger;
/**
- * @author pete
*
* ConnectionFactory is responsible for creating new connections. Eventually,
* the connection factory should read an external configuration file and create
@@ -84,12 +83,6 @@
public void testIterationStart(LoopIterationEvent event) {
}
- /**
- *
- * @param ctx
- * @param fac
- * @return
- */
public static synchronized TopicConnectionFactory
getTopicConnectionFactory(Context ctx, String fac) {
while (factory == null) {
try {
@@ -104,12 +97,6 @@
return factory;
}
- /**
- *
- * @param ctx
- * @param fac
- * @return
- */
public static synchronized QueueConnectionFactory
getQueueConnectionFactory(Context ctx, String fac) {
while (qfactory == null) {
try {
@@ -124,10 +111,6 @@
return qfactory;
}
- /**
- *
- * @return
- */
public static synchronized TopicConnection getTopicConnection() {
if (factory != null) {
try {
@@ -139,12 +122,6 @@
return null;
}
- /**
- *
- * @param ctx
- * @param queueConn
- * @return
- */
public static QueueConnection getQueueConnection(Context ctx, String
queueConn) {
if (factory != null) {
try {
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/InitialContextFactory.java
Tue Nov 20 08:00:49 2007
@@ -73,7 +73,7 @@
*
* @param ctx
* @param name
- * @return
+ * @return the topic or null
*/
public static synchronized Topic lookupTopic(Context ctx, String name) {
Topic t = null;
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/OnMessageSubscriber.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/OnMessageSubscriber.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/OnMessageSubscriber.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/OnMessageSubscriber.java
Tue Nov 20 08:00:49 2007
@@ -93,7 +93,7 @@
* @param useAuth
* @param user
* @param pwd
- * @return
+ * @return the context or null
*/
public Context initJNDI(boolean useProps, String jndi, String url,
String useAuth, String user, String pwd) {
if (useProps) {
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/client/ReceiveSubscriber.java
Tue Nov 20 08:00:49 2007
@@ -32,12 +32,6 @@
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;
-/**
- * @author pete
- *
- * To change the template for this generated type comment go to
- * Window>Preferences>Java>Code Generation>Code and Comments
- */
public class ReceiveSubscriber implements Runnable {
private static Logger log = LoggingManager.getLoggerForClass();
@@ -89,7 +83,7 @@
* @param useAuth
* @param user
* @param pwd
- * @return
+ * @return the JNDI initial context or null
*/
public Context initJNDI(boolean useProps, String jndi, String url,
String useAuth, String user, String pwd) {
if (useProps) {
@@ -152,7 +146,6 @@
/**
* Get the message as a string
*
- * @return
*/
public String getMessage() {
return this.buffer.toString();
@@ -161,7 +154,6 @@
/**
* Get the message(s) as an array of byte[]
*
- * @return
*/
public byte[] getByteResult() {
if (this.buffer.length() > 0) {
@@ -207,18 +199,16 @@
/**
* Increment the count and return the new value
*
- * @param count
- * @return
+ * @param increment
*/
- public synchronized int count(int count) {
- counter += count;
+ public synchronized int count(int increment) {
+ counter += increment;
return counter;
}
/**
* Reset will reset the counter and prepare for the next sample() call.
*
- * @return
*/
public synchronized int resetCount() {
counter = 0;
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/JMSSampler.java
Tue Nov 20 08:00:49 2007
@@ -398,9 +398,6 @@
}
}
- /**
- * @return
- */
public int getTimeout() {
if (getPropertyAsInt(TIMEOUT) < 1) {
return DEFAULT_TIMEOUT;
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/PublisherSampler.java
Tue Nov 20 08:00:49 2007
@@ -122,7 +122,7 @@
* The implementation will publish n messages within a for loop. Once n
* messages are published, it sets the attributes of SampleResult.
*
- * @return
+ * @return the populated sample result
*/
public SampleResult sample() {
SampleResult result = new SampleResult();
@@ -154,7 +154,7 @@
/**
* Method will check the setting and get the contents for the message.
*
- * @return
+ * @return the contents for the message
*/
public String getMessageContent() {
if (this.getConfigChoice().equals(JMSPublisherGui.use_file)) {
@@ -180,7 +180,7 @@
* returns a string.
*
* @param path
- * @return
+ * @return the contents of the file
*/
public String getFileContent(String path) {
TextFile tf = new TextFile(path);
@@ -200,7 +200,6 @@
/**
* return the config choice
*
- * @return
*/
public String getConfigChoice() {
return getPropertyAsString(CONFIG_CHOICE);
@@ -218,7 +217,6 @@
/**
* return the source of the message
*
- * @return
*/
public String getMessageChoice() {
return getPropertyAsString(MESSAGE_CHOICE);
@@ -236,7 +234,6 @@
/**
* return the path of the input file
*
- * @return
*/
public String getInputFile() {
return getPropertyAsString(INPUT_FILE);
@@ -254,7 +251,6 @@
/**
* return the random path for messages
*
- * @return
*/
public String getRandomPath() {
return getPropertyAsString(RANDOM_PATH);
@@ -272,7 +268,6 @@
/**
* return the text for the message
*
- * @return
*/
public String getTextMessage() {
return getPropertyAsString(TEXT_MSG);
Modified:
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
(original)
+++
jakarta/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/SubscriberSampler.java
Tue Nov 20 08:00:49 2007
@@ -36,7 +36,6 @@
import org.apache.log.Logger;
/**
- * @author pete
*
* To change the template for this generated type comment go to
* Window>Preferences>Java>Code Generation>Code and Comments
@@ -99,7 +98,6 @@
* Create the OnMessageSubscriber client and set the sampler as the
message
* listener.
*
- * @return
*/
public synchronized OnMessageSubscriber initListenerClient() {
OnMessageSubscriber sub = (OnMessageSubscriber)
ClientPool.get(this);
@@ -143,7 +141,7 @@
* sample method will check which client it should use and call the
* appropriate client specific sample method.
*
- * @return
+ * @return the appropriate sample result
*/
public SampleResult sample() {
if
(this.getClientChoice().equals(JMSSubscriberGui.receive_str)) {
@@ -156,7 +154,7 @@
/**
* sample will block until messages are received
*
- * @return
+ * @return the sample result
*/
public SampleResult sampleWithListener() {
SampleResult result = new SampleResult();
@@ -193,7 +191,7 @@
* Sample method uses the ReceiveSubscriber client instead of onMessage
* approach.
*
- * @return
+ * @return the sample result
*/
public SampleResult sampleWithReceive() {
SampleResult result = new SampleResult();
@@ -252,11 +250,11 @@
/**
* increment the count and return the new value.
*
- * @param count
- * @return
+ * @param increment
+ * @return the new value
*/
- public synchronized int count(int count) {
- this.counter += count;
+ public synchronized int count(int increment) {
+ this.counter += increment;
return this.counter;
}
@@ -281,7 +279,7 @@
/**
* Return the client choice.
*
- * @return
+ * @return the client choice
*/
public String getClientChoice() {
return getPropertyAsString(CLIENT_CHOICE);
Modified:
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryDialoger.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryDialoger.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
---
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryDialoger.java
(original)
+++
jakarta/jmeter/trunk/src/reports/org/apache/jmeter/gui/util/DirectoryDialoger.java
Tue Nov 20 08:00:49 2007
@@ -26,10 +26,6 @@
import org.apache.jmeter.gui.ReportGuiPackage;
import org.apache.jmeter.util.JMeterUtils;
-/**
- * @author Peter Lin
- * @version $Revision$
- */
public final class DirectoryDialoger {
/**
* The last directory visited by the user while choosing Files.
@@ -44,10 +40,6 @@
private DirectoryDialoger() {
}
- /**
- *
- * @return
- */
public static JFileChooser promptToOpenFile() {
if (lastJFCDirectory == null) {
Modified: jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/DataSet.java
URL:
http://svn.apache.org/viewvc/jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/DataSet.java?rev=596725&r1=596724&r2=596725&view=diff
==============================================================================
--- jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/DataSet.java
(original)
+++ jakarta/jmeter/trunk/src/reports/org/apache/jmeter/report/DataSet.java Tue
Nov 20 08:00:49 2007
@@ -26,7 +26,6 @@
import org.apache.jmeter.visualizers.Visualizer;
/**
- * @author Peter Lin
*
* DataSet extends Visualizer so that it can be used with ResultCollector.
* Classes implementing the interface should create a new instance of
@@ -45,7 +44,6 @@
/**
* Return the datasource. For files, it should be the absolute path.
* For databases, it should be the datasource name created in jmeter.
- * @return
*/
public String getDataSource();
/**
@@ -53,7 +51,6 @@
* datasource string or something different. For example, we may
* want to return just the filename and not the absolutePath of
* a JTL file.
- * @return
*/
public String getDataSourceName();
/**
@@ -63,7 +60,6 @@
public void setStartTimestamp(long stamp);
/**
* return the timestamp in millisecond format.
- * @return
*/
public long getStartTimestamp();
/**
@@ -73,47 +69,40 @@
public void setEndTimestamp(long stamp);
/**
* return the timestamp in millisecond format.
- * @return
*/
public long getEndTimestamp();
/**
* Return the Date object using the start timestamp
- * @return
*/
public Date getDate();
/**
* convienance method for getting the date in mmdd format
- * @return
*/
public String getMonthDayDate();
/**
* convienant method for getting the date in yyyymmdd format
- * @return
*/
public String getMonthDayYearDate();
/**
* Classes implementing the method should return the URL's in the
* DataSet. It is up to the class to return Strings or URL.
- * @return
*/
public Set getURLs();
/**
* Classes implementing the method should return instance of
* SamplingStatCalculator.
- * @return
+ * @return the set of statistics
*/
public Set getStats();
/**
- * Return the SamplingStatCalculate for a specific URL.
+ * Return the SamplingStatCalculator for a specific URL.
* @param url
- * @return
*/
public SamplingStatCalculator getStatistics(String url);
/**
- * Convienance method for getting all the SamplingStatCalculator for
+ * Convienance method for getting all the SamplingStatCalculators for
* a given URL.
* @param urls
- * @return
*/
public List getStats(List urls);
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
