jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1649531 - in /jmeter/trunk/src: components/org/apache/jmeter/control/ components/org/apache/jmeter/visualizers/ core/org/apache/jmeter/engine/util/ core/org/apache/jmeter/gui/util/ jorphan/org/apache/commons/cli/avalon/ jorphan/org/apache/...
Date Mon, 05 Jan 2015 14:18:14 GMT
Author: fschumacher
Date: Mon Jan  5 14:18:13 2015
New Revision: 1649531

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

Modified:
    jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java
    jmeter/trunk/src/core/org/apache/jmeter/engine/util/FunctionParser.java
    jmeter/trunk/src/core/org/apache/jmeter/gui/util/HeaderAsPropertyRenderer.java
    jmeter/trunk/src/jorphan/org/apache/commons/cli/avalon/Token.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java
    jmeter/trunk/src/jorphan/org/apache/jorphan/exec/StreamCopier.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Authorization.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC4CookieHandler.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Proxy.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPJavaImpl.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java
    jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/AbstractJDBCTestElement.java
    jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/QueueExecutor.java

Modified: jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java Mon Jan 
5 14:18:13 2015
@@ -118,6 +118,8 @@ public class IncludeController extends G
 
     /**
      * load the included elements using SaveService
+     *
+     * @return tree with loaded elements
      */
     protected HashTree loadIncludedElements() {
         // only try to load the JMX test plan if there is one

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java (original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/Spline3.java Mon Jan  5 14:18:13
2015
@@ -263,6 +263,8 @@ public class Spline3 {
     /**
      * Test if the Jacobi resolution of the equation system converges. It's OK
      * if A has a strong diagonal.
+     *
+     * @return <code>true</code> if equation system converges
      */
     protected boolean converge() {
         boolean converge = true;
@@ -287,6 +289,13 @@ public class Spline3 {
 
     /**
      * Computes the current precision reached.
+     *
+     * @param oldX
+     *            old values
+     * @param newX
+     *            new values
+     * @return indicator of how different the old and new values are (always
+     *         zero or greater, the nearer to zero the more similar)
      */
     protected float precision(float[] oldX, float[] newX) {
         float N = 0F, D = 0F, erreur = 0F;

Modified: jmeter/trunk/src/core/org/apache/jmeter/engine/util/FunctionParser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/engine/util/FunctionParser.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/engine/util/FunctionParser.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/engine/util/FunctionParser.java Mon Jan  5 14:18:13
2015
@@ -51,6 +51,7 @@ class FunctionParser {
      * @param value string containing the function / variable references (if any)
      *
      * @return list of Strings or Objects representing functions
+     * @throws InvalidVariableException when evaluation of variables fail
      */
     LinkedList<Object> compileString(String value) throws InvalidVariableException
{
         StringReader reader = new StringReader(value);
@@ -111,6 +112,7 @@ class FunctionParser {
      *
      * @param reader points to input after the "${"
      * @return the function or variable object (or a String)
+     * @throws InvalidVariableException when evaluation of variables fail
      */
     Object makeFunction(StringReader reader) throws InvalidVariableException {
         char[] current = new char[1];
@@ -178,6 +180,7 @@ class FunctionParser {
      * </ul>
      * @param reader a StringReader pointing to the current input location, just after "("
      * @return a list of CompoundVariable elements
+     * @throws InvalidVariableException when evaluation of variables fail
      */
     LinkedList<CompoundVariable> parseParams(StringReader reader) throws InvalidVariableException
{
         LinkedList<CompoundVariable> result = new LinkedList<CompoundVariable>();

Modified: jmeter/trunk/src/core/org/apache/jmeter/gui/util/HeaderAsPropertyRenderer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/gui/util/HeaderAsPropertyRenderer.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/gui/util/HeaderAsPropertyRenderer.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/gui/util/HeaderAsPropertyRenderer.java Mon Jan
 5 14:18:13 2015
@@ -72,9 +72,9 @@ public class HeaderAsPropertyRenderer ex
     /**
      * Get the text for the value as the translation of the resource name.
      *
-     * @param value
-     * @param column
-     * @param row
+     * @param value value for which to get the translation
+     * @param column index which column message parameters should be used
+     * @param row not used
      * @return the text
      */
     protected String getText(Object value, int row, int column) {

Modified: jmeter/trunk/src/jorphan/org/apache/commons/cli/avalon/Token.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/commons/cli/avalon/Token.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/commons/cli/avalon/Token.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/commons/cli/avalon/Token.java Mon Jan  5 14:18:13
2015
@@ -37,6 +37,11 @@ class Token {
 
     /**
      * New Token object with a type and value
+     *
+     * @param type
+     *            type of the token
+     * @param value
+     *            value of the token
      */
     Token(final int type, final String value) {
         m_type = type;
@@ -45,6 +50,8 @@ class Token {
 
     /**
      * Get the value of the token
+     *
+     * @return value of the token
      */
     final String getValue() {
         return m_value;
@@ -52,6 +59,8 @@ class Token {
 
     /**
      * Get the type of the token
+     *
+     * @return type of the token
      */
     final int getType() {
         return m_type;

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/collections/HashTree.java Mon Jan  5 14:18:13
2015
@@ -67,6 +67,7 @@ public class HashTree implements Seriali
 
     /**
      * Allow subclasses to provide their own Map.
+     * @param _map {@link Map} to use
      */
     protected HashTree(Map<Object, HashTree> _map) {
         this(_map, null);
@@ -661,7 +662,10 @@ public class HashTree implements Seriali
      * classes should override these methods and create the appropriate subclass
      * of HashTree.
      *
-     * @return HashTree
+     * @param key
+     *            object to use as the key for the top level
+     *
+     * @return newly created {@link HashTree}
      */
     protected HashTree createNewTree(Object key) {
         return new HashTree(key);
@@ -675,7 +679,9 @@ public class HashTree implements Seriali
      * classes should override these methods and create the appropriate subclass
      * of HashTree.
      *
-     * @return HashTree
+     * @param values objects to be added to the new {@link HashTree}
+     *
+     * @return newly created {@link HashTree}
      */
     protected HashTree createNewTree(Collection<?> values) {
         return new HashTree(values);

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/exec/StreamCopier.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/exec/StreamCopier.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/exec/StreamCopier.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/exec/StreamCopier.java Mon Jan  5 14:18:13
2015
@@ -39,7 +39,7 @@ class StreamCopier extends Thread {
 
     /**
      * @param is {@link InputStream}
-     * @param is {@link OutputStream}
+     * @param os {@link OutputStream}
      * @throws IOException 
      */
     StreamCopier(InputStream is, OutputStream os) throws IOException {

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/config/gui/UrlConfigGui.java
Mon Jan  5 14:18:13 2015
@@ -765,6 +765,10 @@ public class UrlConfigGui extends JPanel
     }
 
     /**
+     * Checks if no data is available in the selected tab
+     *
+     * @param oldSelectedIndex
+     *            the tab to check for data
      * @return true if neither Parameters tab nor Raw Body tab contain data
      */
     boolean noData(int oldSelectedIndex) {

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Authorization.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Authorization.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Authorization.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Authorization.java
Mon Jan  5 14:18:13 2015
@@ -49,6 +49,12 @@ public class Authorization extends Abstr
 
     /**
      * create the authorization
+     * @param url url for which the authorization should be considered
+     * @param user name of the user
+     * @param pass password for the user
+     * @param domain authorization domain (used for NTML-authentication)
+     * @param realm authorization realm
+     * @param mechanism authorization mechanism, that should be used
      */
     Authorization(String url, String user, String pass, String domain, String realm, Mechanism
mechanism) {
         setURL(url);

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC4CookieHandler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC4CookieHandler.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC4CookieHandler.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC4CookieHandler.java
Mon Jan  5 14:18:13 2015
@@ -158,7 +158,9 @@ public class HC4CookieHandler implements
     /**
      * Get array of valid HttpClient cookies for the URL
      *
+     * @param cookiesCP property with all available cookies
      * @param url the target URL
+     * @param allowVariableCookie flag whether cookies may contain jmeter variables
      * @return array of HttpClient cookies
      *
      */

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Proxy.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Proxy.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Proxy.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Proxy.java Mon Jan
 5 14:18:13 2015
@@ -137,7 +137,7 @@ public class Proxy extends Thread {
      *            the ProxyControl which will receive the generated sampler
      * @param _pageEncodings
      *            reference to the Map of Deamon, with mappings from page urls to encoding
used
-     * @param formEncodingsEncodings
+     * @param _formEncodings
      *            reference to the Map of Deamon, with mappings from form action urls to
encoding used
      */
     void configure(Socket _clientSocket, ProxyControl _target, Map<String, String>
_pageEncodings, Map<String, String> _formEncodings) {

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/ProxyControl.java
Mon Jan  5 14:18:13 2015
@@ -719,7 +719,8 @@ public class ProxyControl extends Generi
      * Filter the response based on the content type.
      * If no include nor exclude filter is specified, the result will be included
      *
-     * @param result the sample result to check, true means result will be kept
+     * @param result the sample result to check
+     * @return <code>true</code> means result will be kept
      */
     boolean filterContentType(SampleResult result) {
         String includeExp = getContentTypeInclude();

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPJavaImpl.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPJavaImpl.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPJavaImpl.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPJavaImpl.java
Mon Jan  5 14:18:13 2015
@@ -214,6 +214,8 @@ public class HTTPJavaImpl extends HTTPAb
      *
      * @param conn
      *            URL from which to read response
+     * @param res
+     *            {@link SampleResult} to read response into
      * @return response content
      * @exception IOException
      *                if an I/O exception occurs

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java (original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLHelper.java Mon
Jan  5 14:18:13 2015
@@ -194,7 +194,7 @@ public class WSDLHelper {
      * therefore external classes should use parse to get the resource at the
      * given location.
      *
-     * @throws IOException
+     * @throws IOException when I/O error occurs
      */
     protected void connect() throws IOException {
         CONN = WSDLURL.openConnection();
@@ -225,6 +225,10 @@ public class WSDLHelper {
     /**
      * Method is used internally to parse the InputStream and build the document
      * using javax.xml.parser API.
+     *
+     * @throws ParserConfigurationException When building {@link DocumentBuilder} fails
+     * @throws IOException when reading the document fails
+     * @throws SAXException when parsing the document fails
      */
     protected void buildDocument() throws ParserConfigurationException, IOException, SAXException
{
         DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance();

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java
Mon Jan  5 14:18:13 2015
@@ -50,35 +50,35 @@ public interface Generator {
     /**
      * The host is the name of the server.
      *
-     * @param host
+     * @param host name of the server
      */
     void setHost(String host);
 
     /**
      * This is the label for the request, which is used in the logs and results.
      *
-     * @param label
+     * @param label label of the request
      */
     void setLabel(String label);
 
     /**
      * The method is the HTTP request method. It's normally POST or GET.
      *
-     * @param post_get
+     * @param post_get method of the HTTP request
      */
     void setMethod(String post_get);
 
     /**
      * Set the request parameters
      *
-     * @param params
+     * @param params request parameter
      */
     void setParams(NVPair[] params);
 
     /**
      * The path is the web page you want to test.
      *
-     * @param path
+     * @param path path of the web page
      */
     void setPath(String path);
 
@@ -93,14 +93,14 @@ public interface Generator {
     /**
      * Set the querystring for the request if the method is GET.
      *
-     * @param querystring
+     * @param querystring query string of the request
      */
     void setQueryString(String querystring);
 
     /**
      * The source logs is the location where the access log resides.
      *
-     * @param sourcefile
+     * @param sourcefile path to the access log file
      */
     void setSourceLogs(String sourcefile);
 
@@ -108,7 +108,7 @@ public interface Generator {
      * The target can be either a java.io.File or a Sampler. We make it generic,
      * so that later on we can use these classes directly from a HTTPSampler.
      *
-     * @param target
+     * @param target target to generate into
      */
     void setTarget(Object target);
 

Modified: jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/AbstractJDBCTestElement.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/AbstractJDBCTestElement.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/AbstractJDBCTestElement.java
(original)
+++ jmeter/trunk/src/protocol/jdbc/org/apache/jmeter/protocol/jdbc/AbstractJDBCTestElement.java
Mon Jan  5 14:18:13 2015
@@ -142,6 +142,10 @@ public abstract class AbstractJDBCTestEl
      * Execute the test element.
      * 
      * @param conn a {@link SampleResult} in case the test should sample; <code>null</code>
if only execution is requested
+     * @return the result of the execute command
+     * @throws SQLException if a database error occurs
+     * @throws UnsupportedEncodingException when the result can not be converted to the required
charset
+     * @throws IOException when I/O error occurs
      * @throws UnsupportedOperationException if the user provided incorrect query type 
      */
     protected byte[] execute(Connection conn) throws SQLException, UnsupportedEncodingException,
IOException, UnsupportedOperationException {

Modified: jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/QueueExecutor.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/QueueExecutor.java?rev=1649531&r1=1649530&r2=1649531&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/QueueExecutor.java
(original)
+++ jmeter/trunk/src/protocol/jms/org/apache/jmeter/protocol/jms/sampler/QueueExecutor.java
Mon Jan  5 14:18:13 2015
@@ -32,9 +32,9 @@ public interface QueueExecutor {
      * Sends and receives a message.
      * 
      * @param request the message to send
-     * @param deliveryMode
-     * @param priority
-     * @param expiration
+     * @param deliveryMode the delivery mode to use
+     * @param priority the priority for this message
+     * @param expiration messages lifetime in ms
      * @return the received message or <code>null</code>
      * @throws JMSException
      *             in case of an exception from the messaging system



Mime
View raw message