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/14 21:30:33 UTC
svn commit: r1639778 - in /jmeter/trunk/src:
components/org/apache/jmeter/extractor/ core/org/apache/jmeter/gui/
core/org/apache/jmeter/gui/action/ core/org/apache/jmeter/gui/tree/
core/org/apache/jmeter/testbeans/gui/ core/org/apache/jmeter/testelemen...
Author: fschumacher
Date: Fri Nov 14 20:30:33 2014
New Revision: 1639778
URL: http://svn.apache.org/r1639778
Log:
Bug 57193: * Generics won't work in javadoc, so describe the type
textually. * add missing return and throws javadoc statements
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/components/org/apache/jmeter/extractor/Extractor.java
jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java
jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java
jmeter/trunk/src/core/org/apache/jmeter/gui/action/Searcher.java
jmeter/trunk/src/core/org/apache/jmeter/gui/action/UndoCommand.java
jmeter/trunk/src/core/org/apache/jmeter/gui/tree/JMeterTreeNode.java
jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/TableEditor.java
jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractTestElement.java
jmeter/trunk/src/core/org/apache/jmeter/threads/FindTestElementsUpToRootTraverser.java
jmeter/trunk/src/core/org/apache/jmeter/threads/SamplePackage.java
jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreatorFactory.java
jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java
Modified: jmeter/trunk/src/components/org/apache/jmeter/extractor/Extractor.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/extractor/Extractor.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/extractor/Extractor.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/extractor/Extractor.java Fri Nov 14 20:30:33 2014
@@ -32,7 +32,7 @@ public interface Extractor extends Seria
* @param attribute Attribute name to return
* @param matchNumber Match number
* @param inputString Page or excerpt
- * @param result List<String> results
+ * @param result List of results
* @param found current matches found
* @param cacheKey If not null, the implementation is encouraged to cache parsing result and use this key as part of cache key
* @return match found updated
Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/GuiPackage.java Fri Nov 14 20:30:33 2014
@@ -766,7 +766,7 @@ public final class GuiPackage implements
/**
*
- * @return List<IStoppable> Copy of IStoppable
+ * @return copy of list of {@link Stoppable}s
*/
public List<Stoppable> getStoppables() {
ArrayList<Stoppable> list = new ArrayList<Stoppable>();
Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/Searchable.java Fri Nov 14 20:30:33 2014
@@ -25,7 +25,7 @@ import java.util.List;
*/
public interface Searchable {
/**
- * @return List<String> of searchable tokens
+ * @return List of searchable tokens
* @throws Exception
*/
List<String> getSearchableTokens()
Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/action/Searcher.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/action/Searcher.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/action/Searcher.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/action/Searcher.java Fri Nov 14 20:30:33 2014
@@ -27,7 +27,7 @@ public interface Searcher {
/**
* Implements the search
- * @param textTokens List<String> content to be searched
+ * @param textTokens List of content to be searched
* @return true if search on textTokens is successful
*/
boolean search(List<String> textTokens);
Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/action/UndoCommand.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/action/UndoCommand.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/action/UndoCommand.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/action/UndoCommand.java Fri Nov 14 20:30:33 2014
@@ -55,7 +55,7 @@ public class UndoCommand implements Comm
}
/**
- * @return Set<String>
+ * @return Set of all action names
*/
@Override
public Set<String> getActionNames() {
@@ -67,6 +67,7 @@ public class UndoCommand implements Comm
* and clone tree for saving
*
* @param tree to be converted and cloned
+ * @return converted and cloned tree
*/
public static HashTree convertAndCloneSubTree(HashTree tree) {
Save executor = new Save();
Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/tree/JMeterTreeNode.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/tree/JMeterTreeNode.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/tree/JMeterTreeNode.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/tree/JMeterTreeNode.java Fri Nov 14 20:30:33 2014
@@ -73,7 +73,7 @@ public class JMeterTreeNode extends Defa
/**
* Return nodes to level 2
- * @return {@link List}<JMeterTreeNode>
+ * @return {@link List} of {@link JMeterTreeNode}s
*/
public List<JMeterTreeNode> getPathToThreadGroup() {
List<JMeterTreeNode> nodes = new ArrayList<JMeterTreeNode>();
Modified: jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/TableEditor.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/TableEditor.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/TableEditor.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testbeans/gui/TableEditor.java Fri Nov 14 20:30:33 2014
@@ -52,7 +52,9 @@ import org.apache.log.Logger;
/**
* Table editor for TestBean GUI properties.
* Currently only works for:
- * - property type Collection<String>, where there is a single header entry
+ * <ul>
+ * <li>property type Collection of {@link String}s, where there is a single header entry</li>
+ * </ul>
*/
public class TableEditor extends PropertyEditorSupport implements FocusListener,TestBeanPropertyEditor,TableModelListener {
private static final Logger log = LoggingManager.getLoggerForClass();
Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractTestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractTestElement.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractTestElement.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/AbstractTestElement.java Fri Nov 14 20:30:33 2014
@@ -643,8 +643,8 @@ public abstract class AbstractTestElemen
/**
* Add to result the values of propertyNames
- * @param result List<String> values of propertyNames
- * @param propertyNames Set<String> properties to extract
+ * @param result List of values of propertyNames
+ * @param propertyNames Set of names of properties to extract
*/
protected final void addPropertiesValues(List<String> result, Set<String> propertyNames) {
PropertyIterator iterator = propertyIterator();
Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/FindTestElementsUpToRootTraverser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/FindTestElementsUpToRootTraverser.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/FindTestElementsUpToRootTraverser.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/FindTestElementsUpToRootTraverser.java Fri Nov 14 20:30:33 2014
@@ -86,7 +86,7 @@ public class FindTestElementsUpToRootTra
/**
* Returns all controllers that where in Tree down to nodeToFind in reverse order (from leaf to root)
- * @return List<Controller>
+ * @return List of {@link Controller}
*/
public List<Controller> getControllersToRoot() {
List<Controller> result = new ArrayList<Controller>(stack.size());
Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/SamplePackage.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/SamplePackage.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/SamplePackage.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/SamplePackage.java Fri Nov 14 20:30:33 2014
@@ -128,7 +128,7 @@ public class SamplePackage {
}
/**
- * @return List<SampleListener>
+ * @return List of {@link SampleListener}s
*/
public List<SampleListener> getSampleListeners() {
return sampleListeners;
@@ -143,7 +143,7 @@ public class SamplePackage {
}
/**
- * @return List<Timer>
+ * @return List of {@link Timer}s
*/
public List<Timer> getTimers() {
return timers;
@@ -183,14 +183,14 @@ public class SamplePackage {
}
/**
- * @return List<Assertion>
+ * @return List of {@link Assertion}
*/
public List<Assertion> getAssertions() {
return assertions;
}
/**
- * @return List<PostProcessor>
+ * @return List of {@link PostProcessor}s
*/
public List<PostProcessor> getPostProcessors() {
return postProcessors;
@@ -212,7 +212,7 @@ public class SamplePackage {
/**
* Returns the preProcessors.
- * @return List<PreProcessor>
+ * @return List of {@link PreProcessor}
*/
public List<PreProcessor> getPreProcessors() {
return preProcessors;
@@ -221,7 +221,7 @@ public class SamplePackage {
/**
* Returns the configs.
*
- * @return List
+ * @return List of {@link ConfigTestElement}
*/
public List<ConfigTestElement> getConfigs() {
return configs;
Modified: jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/util/XPathUtil.java Fri Nov 14 20:30:33 2014
@@ -300,7 +300,7 @@ public class XPathUtil {
* Put in matchStrings results of evaluation
* @param document XML document
* @param xPathQuery XPath Query
- * @param matchStrings List<String> that will be filled
+ * @param matchStrings List of strings that will be filled
* @param fragment return fragment
* @throws TransformerException
*/
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/DefaultSamplerCreator.java Fri Nov 14 20:30:33 2014
@@ -114,8 +114,8 @@ public class DefaultSamplerCreator exten
* Compute sampler informations from Request Header
* @param sampler {@link HTTPSamplerBase}
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
* @throws Exception
*/
protected void computeFromHeader(HTTPSamplerBase sampler,
@@ -311,9 +311,10 @@ public class DefaultSamplerCreator exten
* Compute content encoding
* @param sampler {@link HTTPSamplerBase}
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
- * @throws MalformedURLException
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
+ * @throws MalformedURLException when no {@link URL} could be built from
+ * <code>sampler</code> and <code>request</code>
*/
protected void computeContentEncoding(HTTPSamplerBase sampler,
HttpRequestHdr request, Map<String, String> pageEncodings,
@@ -342,8 +343,8 @@ public class DefaultSamplerCreator exten
* Computes content encoding from request and if not found uses pageEncoding
* and formEncoding to see if URL was previously computed with a content type
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
* @return String content encoding
*/
protected String computeContentEncoding(HttpRequestHdr request,
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreator.java Fri Nov 14 20:30:33 2014
@@ -36,8 +36,8 @@ public interface SamplerCreator {
/**
* Create HTTPSamplerBase
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
* @return {@link HTTPSamplerBase}
*/
HTTPSamplerBase createSampler(HttpRequestHdr request,
@@ -47,8 +47,8 @@ public interface SamplerCreator {
* Populate sampler from request
* @param sampler {@link HTTPSamplerBase}
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
* @throws Exception
*/
void populateSampler(HTTPSamplerBase sampler,
@@ -72,9 +72,10 @@ public interface SamplerCreator {
* <li>{@link SamplerCreator}{@link #populateSampler(HTTPSamplerBase, HttpRequestHdr, Map, Map)}</li>
* </ol>
* @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String>
- * @param formEncodings Map<String, String>
+ * @param pageEncodings Map of page encodings
+ * @param formEncodings Map of form encodings
* @return {@link HTTPSamplerBase}
+ * @throws Exception
* @since 2.9
*/
HTTPSamplerBase createAndPopulateSampler(HttpRequestHdr request,
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreatorFactory.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreatorFactory.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreatorFactory.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/SamplerCreatorFactory.java Fri Nov 14 20:30:33 2014
@@ -88,10 +88,10 @@ public class SamplerCreatorFactory {
/**
* Gets {@link SamplerCreator} for content type, if none is found returns {@link DefaultSamplerCreator}
- * @param request {@link HttpRequestHdr}
- * @param pageEncodings Map<String, String> pageEncodings
- * @param formEncodings Map<String, String> formEncodings
- * @return SamplerCreator
+ * @param request {@link HttpRequestHdr} from which the content type should be used
+ * @param pageEncodings Map of pageEncodings
+ * @param formEncodings Map of formEncodings
+ * @return SamplerCreator for the content type of the <code>request</code>, or {@link DefaultSamplerCreator} when none is found
*/
public SamplerCreator getSamplerCreator(HttpRequestHdr request,
Map<String, String> pageEncodings, Map<String, String> formEncodings) {
Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java Fri Nov 14 20:30:33 2014
@@ -534,7 +534,7 @@ public class TCLogParser implements LogP
* purpose of this utility.
*
* @param parameters
- * @return List<String>
+ * @return List of name/value pairs
*/
protected List<String> parseParameters(String parameters) {
List<String> parsedParams = new ArrayList<String>();
Modified: jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java?rev=1639778&r1=1639777&r2=1639778&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java (original)
+++ jmeter/trunk/src/protocol/mail/org/apache/jmeter/protocol/smtp/sampler/protocol/SendMailCommand.java Fri Nov 14 20:30:33 2014
@@ -411,14 +411,14 @@ public class SendMailCommand {
* SmtpSampler-object
*
* @param receiverTo
- * List of receivers <InternetAddress>
+ * List of receivers
*/
public void setReceiverTo(List<InternetAddress> receiverTo) {
this.receiverTo = receiverTo;
}
/**
- * Returns receivers of current message <InternetAddress> ("cc") - standard
+ * Returns receivers of current message as {@link InternetAddress} ("cc") - standard
* getter
*
* @return List of receivers
@@ -432,14 +432,14 @@ public class SendMailCommand {
* SmtpSampler-object
*
* @param receiverCC
- * List of receivers <InternetAddress>
+ * List of receivers
*/
public void setReceiverCC(List<InternetAddress> receiverCC) {
this.receiverCC = receiverCC;
}
/**
- * Returns receivers of current message <InternetAddress> ("bcc") - standard
+ * Returns receivers of current message as {@link InternetAddress} ("bcc") - standard
* getter
*
* @return List of receivers
@@ -453,7 +453,7 @@ public class SendMailCommand {
* SmtpSampler-object
*
* @param receiverBCC
- * List of receivers <InternetAddress>
+ * List of receivers
*/
public void setReceiverBCC(List<InternetAddress> receiverBCC) {
this.receiverBCC = receiverBCC;