jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1647347 - in /jmeter/trunk/src/core/org/apache/jmeter: save/converters/ services/ testbeans/
Date Mon, 22 Dec 2014 16:25:38 GMT
Author: fschumacher
Date: Mon Dec 22 16:25:38 2014
New Revision: 1647347

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

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/BooleanPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/ConversionHelp.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/HashTreeConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/IntegerPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/LongPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/MultiPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleEventConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleResultConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleSaveConfigurationConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/StringPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementPropertyConverter.java
    jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
    jmeter/trunk/src/core/org/apache/jmeter/testbeans/TestBeanHelper.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/BooleanPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/BooleanPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/BooleanPropertyConverter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/BooleanPropertyConverter.java
Mon Dec 22 16:25:38 2014
@@ -31,6 +31,8 @@ public class BooleanPropertyConverter im
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/ConversionHelp.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/ConversionHelp.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/ConversionHelp.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/ConversionHelp.java Mon Dec 22
16:25:38 2014
@@ -102,6 +102,13 @@ public class ConversionHelp {
         }
     }
 
+    /**
+     * Decode a string if {@link #inVersion} equals <code>1.0</code>
+     * 
+     * @param p
+     *            the string to be decoded
+     * @return the newly decoded string
+     */
     public static String decode(String p) {
         if (!"1.0".equals(inVersion)) {//$NON-NLS-1$
             return p;
@@ -118,6 +125,18 @@ public class ConversionHelp {
         }
     }
 
+    /**
+     * Embed an array of bytes as a string with <code>encoding</code> in a
+     * xml-cdata section
+     * 
+     * @param chars
+     *            bytes to be encoded and embedded
+     * @param encoding
+     *            the encoding to be used
+     * @return the encoded string embedded in a xml-cdata section
+     * @throws UnsupportedEncodingException
+     *             when the bytes can not be encoded using <code>encoding</code>
+     */
     public static String cdata(byte[] chars, String encoding) throws UnsupportedEncodingException
{
         StringBuilder buf = new StringBuilder("<![CDATA[");
         buf.append(new String(chars, encoding));
@@ -125,7 +144,9 @@ public class ConversionHelp {
         return buf.toString();
     }
 
-    // Names of properties that are handled specially
+    /**
+     *  Names of properties that are handled specially
+     */
     private static final Map<String, String> propertyToAttribute=new HashMap<String,
String>();
 
     private static void mapentry(String prop, String att){
@@ -181,6 +202,14 @@ public class ConversionHelp {
         }
     }
 
+    /**
+     * Check whether <code>name</code> specifies a <em>special</em>
property
+     * 
+     * @param name
+     *            the name of the property to be checked
+     * @return <code>true</code> if <code>name</code> is the name
of a special
+     *         property
+     */
     public static boolean isSpecialProperty(String name) {
        return propertyToAttribute.containsKey(name);
     }
@@ -206,6 +235,7 @@ public class ConversionHelp {
      * 
      * @param reader where to read the value
      * @param context the unmarshalling context
+     * @param name the name of the property
      * 
      * @return the property value, updated if necessary.
      * @see #getUpgradePropertyValue(String, String, UnmarshallingContext)
@@ -258,8 +288,12 @@ public class ConversionHelp {
      * <li>TestElement.NAME</li>
      * <li>TestElement.ENABLED</li>
      * </ul>
+     * 
      * @param testElement
+     *            element for which the special properties should be saved
      * @param writer
+     *            {@link HierarchicalStreamWriter} in which the special
+     *            properties should be saved
      */
     public static void saveSpecialProperties(TestElement testElement, HierarchicalStreamWriter
writer) {
         saveClass(testElement,writer,TestElement.GUI_CLASS);
@@ -276,8 +310,12 @@ public class ConversionHelp {
      * <li>TestElement.NAME</li>
      * <li>TestElement.ENABLED</li>
      * </ul>
+     * 
      * @param testElement
+     *            in which the special properties should be restored
      * @param reader
+     *            {@link HierarchicalStreamReader} from which the special
+     *            properties should be restored
      */
     public static void restoreSpecialProperties(TestElement testElement, HierarchicalStreamReader
reader) {
         restoreClass(testElement,reader,TestElement.GUI_CLASS);

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/HashTreeConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/HashTreeConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/HashTreeConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/HashTreeConverter.java Mon Dec
22 16:25:38 2014
@@ -32,6 +32,8 @@ public class HashTreeConverter extends A
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$";  //$NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/IntegerPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/IntegerPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/IntegerPropertyConverter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/IntegerPropertyConverter.java
Mon Dec 22 16:25:38 2014
@@ -31,6 +31,8 @@ public class IntegerPropertyConverter im
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/LongPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/LongPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/LongPropertyConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/LongPropertyConverter.java Mon
Dec 22 16:25:38 2014
@@ -31,6 +31,8 @@ public class LongPropertyConverter imple
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/MultiPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/MultiPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/MultiPropertyConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/MultiPropertyConverter.java Mon
Dec 22 16:25:38 2014
@@ -36,6 +36,8 @@ public class MultiPropertyConverter exte
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$";  //$NON-NLS-1$
@@ -76,7 +78,7 @@ public class MultiPropertyConverter exte
     }
 
     /**
-     * @param arg0
+     * @param arg0 the mapper
      */
     public MultiPropertyConverter(Mapper arg0) {
         super(arg0);

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleEventConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleEventConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleEventConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleEventConverter.java Mon
Dec 22 16:25:38 2014
@@ -33,6 +33,8 @@ public class SampleEventConverter implem
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; //$NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleResultConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleResultConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleResultConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleResultConverter.java Mon
Dec 22 16:25:38 2014
@@ -98,6 +98,8 @@ public class SampleResultConverter exten
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; //$NON-NLS-1$
@@ -416,7 +418,7 @@ public class SampleResultConverter exten
 
 
     /**
-     * @param arg0
+     * @param arg0 the mapper
      */
     public SampleResultConverter(Mapper arg0) {
         super(arg0);

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleSaveConfigurationConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleSaveConfigurationConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleSaveConfigurationConverter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/SampleSaveConfigurationConverter.java
Mon Dec 22 16:25:38 2014
@@ -103,6 +103,8 @@ public class SampleSaveConfigurationConv
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/StringPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/StringPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/StringPropertyConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/StringPropertyConverter.java Mon
Dec 22 16:25:38 2014
@@ -31,6 +31,8 @@ public class StringPropertyConverter imp
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementConverter.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementConverter.java Mon
Dec 22 16:25:38 2014
@@ -41,6 +41,8 @@ public class TestElementConverter extend
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; //$NON-NLS-1$
@@ -121,7 +123,7 @@ public class TestElementConverter extend
     }
 
     /**
-     * @param arg0
+     * @param arg0 the mapper
      */
     public TestElementConverter(Mapper arg0) {
         super(arg0);

Modified: jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementPropertyConverter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementPropertyConverter.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementPropertyConverter.java
(original)
+++ jmeter/trunk/src/core/org/apache/jmeter/save/converters/TestElementPropertyConverter.java
Mon Dec 22 16:25:38 2014
@@ -43,6 +43,8 @@ public class TestElementPropertyConverte
     /**
      * Returns the converter version; used to check for possible
      * incompatibilities
+     * 
+     * @return the version of this converter
      */
     public static String getVersion() {
         return "$Revision$"; // $NON-NLS-1$
@@ -136,7 +138,7 @@ public class TestElementPropertyConverte
     }
 
     /**
-     * @param arg0
+     * @param arg0 the mapper
      */
     public TestElementPropertyConverter(Mapper arg0) {
         super(arg0);

Modified: jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/services/FileServer.java Mon Dec 22 16:25:38 2014
@@ -291,7 +291,7 @@ public class FileServer {
      *
      * @param filename the filename or alias that was used to reserve the file
      * @return String containing the next line in the file
-     * @throws IOException
+     * @throws IOException when reading of the file fails, or the file was not reserved properly
      */
     public String readLine(String filename) throws IOException {
       return readLine(filename, true);
@@ -303,7 +303,7 @@ public class FileServer {
      * @param filename the filename or alias that was used to reserve the file
      * @param recycle - should file be restarted at EOF?
      * @return String containing the next line in the file (null if EOF reached and not recycle)
-     * @throws IOException
+     * @throws IOException when reading of the file fails, or the file was not reserved properly
      */
     public String readLine(String filename, boolean recycle) throws IOException {
         return readLine(filename, recycle, false);
@@ -315,7 +315,7 @@ public class FileServer {
      * @param recycle - should file be restarted at EOF?
      * @param firstLineIsNames - 1st line is fields names
      * @return String containing the next line in the file (null if EOF reached and not recycle)
-     * @throws IOException
+     * @throws IOException when reading of the file fails, or the file was not reserved properly
      */
     public synchronized String readLine(String filename, boolean recycle, 
             boolean firstLineIsNames) throws IOException {
@@ -351,6 +351,7 @@ public class FileServer {
      * @param firstLineIsNames whether the file contains a file header
      * @param delim the delimiter to use for parsing
      * @return the parsed line, will be empty if the file is at EOF
+     * @throws IOException when reading of the aliased file fails, or the file was not reserved
properly
      */
     public synchronized String[] getParsedLine(String alias, boolean recycle, boolean firstLineIsNames,
char delim) throws IOException {
         BufferedReader reader = getReader(alias, recycle, firstLineIsNames);
@@ -444,8 +445,8 @@ public class FileServer {
     }
 
     /**
-     * @param name
-     * @throws IOException
+     * @param name the name or alias of the file to be closed
+     * @throws IOException when closing of the aliased file fails
      */
     public synchronized void closeFile(String name) throws IOException {
         FileEntry fileEntry = files.get(name);
@@ -470,12 +471,19 @@ public class FileServer {
     }
 
     /**
-     * Method will get a random file in a base directory
-     * TODO hey, not sure this method belongs here.  FileServer is for threadsafe
-     * File access relative to current test's base directory.
+     * Method will get a random file in a base directory 
+     * <p>
+     * TODO hey, not sure this
+     * method belongs here. FileServer is for threadsafe File access relative to
+     * current test's base directory.
      *
      * @param basedir
-     * @return a random File from the basedir that matches one of the extensions
+     *            name of the directory in which the files can be found
+     * @param extensions
+     *            array of allowed extensions, if <code>null</code> is given,
+     *            any file be allowed
+     * @return a random File from the <code>basedir</code> that matches one of
+     *         the extensions
      */
     public File getRandomFile(String basedir, String[] extensions) {
         File input = null;
@@ -503,13 +511,15 @@ public class FileServer {
     }
     
     /**
-     * Resolve a file name that may be relative to the base directory.
-     * If the name begins with the value of the JMeter property
-     * "jmeter.save.saveservice.base_prefix" 
-     * - default "~/" - then the name is assumed to be relative to the basename.
+     * Resolve a file name that may be relative to the base directory. If the
+     * name begins with the value of the JMeter property
+     * "jmeter.save.saveservice.base_prefix" - default "~/" - then the name is
+     * assumed to be relative to the basename.
      * 
      * @param relativeName
-     * @return the updated file
+     *            filename that should be checked for
+     *            <code>jmeter.save.saveservice.base_prefix</code>
+     * @return the updated filename
      */
     public static String resolveBaseRelativeName(String relativeName) {
         if (relativeName.startsWith(BASE_PREFIX)){

Modified: jmeter/trunk/src/core/org/apache/jmeter/testbeans/TestBeanHelper.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testbeans/TestBeanHelper.java?rev=1647347&r1=1647346&r2=1647347&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testbeans/TestBeanHelper.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testbeans/TestBeanHelper.java Mon Dec 22 16:25:38
2014
@@ -57,6 +57,7 @@ public class TestBeanHelper {
      * property value map.
      * <p>
      *
+     * @param el the TestElement to be prepared
      * @deprecated to limit it's usage in expectation of moving it elsewhere.
      */
     @Deprecated
@@ -158,8 +159,12 @@ public class TestBeanHelper {
      * Utility method that invokes a method and does the error handling around
      * the invocation.
      *
+     * @param invokee
+     *            the object on which the method should be invoked
      * @param method
+     *            the method which should be invoked
      * @param params
+     *            the parameters for the method
      * @return the result of the method invocation.
      */
     private static Object invokeOrBailOut(Object invokee, Method method, Object[] params)
{
@@ -201,8 +206,8 @@ public class TestBeanHelper {
      * <li>no read method</li>
      * <li>no write method</li>
      * </ul>
-     * @param descriptor
-     * @return true if the descriptor should be ignored
+     * @param descriptor the {@link PropertyDescriptor} to be checked
+     * @return <code>true</code> if the descriptor should be ignored
      */
     public static boolean isDescriptorIgnored(PropertyDescriptor descriptor) {
         return descriptor.isHidden() 



Mime
View raw message