Author: fschumacher Date: Fri Jan 2 21:13:05 2015 New Revision: 1649126 URL: http://svn.apache.org/r1649126 Log: Bug 57193: Add param and return tags to javadoc Bugzilla Id: 57193
Modified: jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java jmeter/trunk/src/jorphan/org/apache/jorphan/gui/DefaultTreeTableModel.java jmeter/trunk/src/jorphan/org/apache/jorphan/gui/GuiUtils.java jmeter/trunk/src/jorphan/org/apache/jorphan/gui/JTreeTable.java jmeter/trunk/src/jorphan/org/apache/jorphan/math/StatCalculator.java jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.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/CacheManager.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieHandler.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieManager.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/DNSCacheManager.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC3CookieHandler.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Header.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HeaderManager.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/gui/WebServiceSamplerGui.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/gui/HTTPFileArgsPanel.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserSequence.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HtmlParsingUtils.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/JsoupBasedHtmlParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/LagartoBasedHtmlParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/RegexpHTMLParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/URLCollection.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Daemon.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/FormCharSetFinder.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/HttpRequestHdr.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/AccessLogSampler.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HttpWebdav.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/PostWriter.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/SoapSampler.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPArgument.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPFileArg.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLException.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/Filter.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Generator.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/OrderPreservingLogParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/StandardGenerator.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/TCLogParser.java jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/visualizers/RequestViewHTTP.java jmeter/trunk/test/src/org/apache/jmeter/JMeterVersionTest.java jmeter/trunk/test/src/org/apache/jmeter/control/TestIfController.java jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestCookieManager.java jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestHTTPMirrorThread.java jmeter/trunk/test/src/org/apache/jmeter/resources/PackageTest.java jmeter/trunk/test/src/org/apache/jmeter/testelement/BarChartTest.java jmeter/trunk/test/src/org/apache/jmeter/testelement/LineGraphTest.java Modified: jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java (original) +++ jmeter/trunk/src/functions/org/apache/jmeter/functions/XPathWrapper.java Fri Jan 2 21:13:05 2015 @@ -42,8 +42,10 @@ final class XPathWrapper { /* * This Map serves two purposes: - * - maps names to containers - * - ensures only one container per file across all threads + * <ul> + * <li>maps names to containers</li> + * <li>ensures only one container per file across all threads</li> + * </ul> * The key is the concatenation of the file name and the XPath string */ //@GuardedBy("fileContainers") @@ -86,8 +88,8 @@ final class XPathWrapper { /** * Not thread-safe - must be called from a synchronized method. * - * @param file - * @param xpathString + * @param file name of the file + * @param xpathString xpath to look up in file * @return the next row from the file container */ public static String getXPathString(String file, String xpathString) { Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/DefaultTreeTableModel.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/DefaultTreeTableModel.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/DefaultTreeTableModel.java (original) +++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/DefaultTreeTableModel.java Fri Jan 2 21:13:05 2015 @@ -32,17 +32,17 @@ public class DefaultTreeTableModel exten } /** - * @param root + * @param root the {@link TreeNode} to use as root */ public DefaultTreeTableModel(TreeNode root) { super(root); } /** - * @param headers - * @param readFunctors - * @param writeFunctors - * @param editorClasses + * @param headers the headers to use + * @param readFunctors the read functors to use + * @param writeFunctors the write functors to use + * @param editorClasses the editor classes to use */ public DefaultTreeTableModel(String[] headers, Functor[] readFunctors, Functor[] writeFunctors, Class<?>[] editorClasses) { Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/GuiUtils.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/GuiUtils.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/GuiUtils.java (original) +++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/GuiUtils.java Fri Jan 2 21:13:05 2015 @@ -85,8 +85,8 @@ public final class GuiUtils { /** * Create a GUI component JLabel + JComboBox with a left and right margin (5px) - * @param label - * @param comboBox + * @param label the label + * @param comboBox the combo box * @return the JComponent (margin+JLabel+margin+JComboBox) */ public static JComponent createLabelCombo(String label, JComboBox comboBox) { @@ -102,6 +102,8 @@ public final class GuiUtils { /** * Stop any editing that is currently being done on the table. This will * save any changes that have already been made. + * + * @param table the table to stop on editing */ public static void stopTableEditing(JTable table) { if (table.isEditing()) { @@ -112,9 +114,12 @@ public final class GuiUtils { /** * Get pasted text from clipboard + * * @return String Pasted text * @throws UnsupportedFlavorException + * if the clipboard data can not be get as a {@link String} * @throws IOException + * if the clipboard data is no longer available */ public static String getPastedText() throws UnsupportedFlavorException, IOException { Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard(); Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/JTreeTable.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/JTreeTable.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/JTreeTable.java (original) +++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/JTreeTable.java Fri Jan 2 21:13:05 2015 @@ -34,31 +34,31 @@ public class JTreeTable extends JTable { } /** - * @param numRows - * @param numColumns + * @param numRows number of rows the table holds + * @param numColumns number of columns the table holds */ public JTreeTable(int numRows, int numColumns) { super(numRows, numColumns); } /** - * @param dm + * @param dm the data model to use */ public JTreeTable(TreeTableModel dm) { super(dm); } /** - * @param rowData - * @param columnNames + * @param rowData the data for the table + * @param columnNames the names for the columns */ public JTreeTable(Object[][] rowData, Object[] columnNames) { super(rowData, columnNames); } /** - * @param rowData - * @param columnNames + * @param rowData the data for the table + * @param columnNames the names for the columns */ public JTreeTable(Vector<?> rowData, Vector<?> columnNames) { super(rowData, columnNames); Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/math/StatCalculator.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/math/StatCalculator.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/jorphan/org/apache/jorphan/math/StatCalculator.java (original) +++ jmeter/trunk/src/jorphan/org/apache/jorphan/math/StatCalculator.java Fri Jan 2 21:13:05 2015 @@ -30,6 +30,8 @@ import org.apache.commons.lang3.mutable. * This class serves as a way to calculate the median, max, min etc. of a list of values. * It is not threadsafe. * + * @param <T> type parameter for the calculator + * */ public abstract class StatCalculator<T extends Number & Comparable<? super T>> { @@ -114,6 +116,8 @@ public abstract class StatCalculator<T e * are below, the remaining 10% are above. * * @param percent + * number representing the wished percent (between <code>0</code> + * and <code>1.0</code>) * @return number of values less than the percentage */ public T getPercentPoint(float percent) { @@ -127,6 +131,8 @@ public abstract class StatCalculator<T e * are below, the remaining 10% are above. * * @param percent + * number representing the wished percent (between <code>0</code> + * and <code>1.0</code>) * @return the value which %percent% of the values are less than */ public T getPercentPoint(double percent) { Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java (original) +++ jmeter/trunk/src/jorphan/org/apache/jorphan/reflect/ClassFinder.java Fri Jan 2 21:13:05 2015 @@ -149,10 +149,16 @@ public final class ClassFinder { /** * Convenience method for - * {@link #findClassesThatExtend(String[], Class[], boolean)} - * with the option to include inner classes in the search set to false. + * {@link #findClassesThatExtend(String[], Class[], boolean)} with the + * option to include inner classes in the search set to false. * + * @param paths + * pathnames or jarfiles to search for classes + * @param superClasses + * required parent class(es) * @return List of Strings containing discovered class names. + * @throws IOException + * when scanning the classes fails */ public static List<String> findClassesThatExtend(String[] paths, Class<?>[] superClasses) throws IOException { @@ -191,6 +197,7 @@ public final class ClassFinder { * @param innerClasses - should we include inner classes? * * @return List containing discovered classes + * @throws IOException when scanning for classes fails */ public static List<String> findClassesThatExtend(String[] strPathsOrJars, final Class<?>[] superClasses, final boolean innerClasses) @@ -207,6 +214,7 @@ public final class ClassFinder { * @param notContains - classname should not contain this string * * @return List containing discovered classes + * @throws IOException when scanning classes fails */ public static List<String> findClassesThatExtend(String[] strPathsOrJars, final Class<?>[] superClasses, final boolean innerClasses, @@ -222,6 +230,7 @@ public final class ClassFinder { * @param innerClasses - should we include inner classes? * * @return List containing discovered classes + * @throws IOException when scanning classes fails */ public static List<String> findAnnotatedClasses(String[] strPathsOrJars, final Class<? extends Annotation>[] annotations, final boolean innerClasses) @@ -237,6 +246,7 @@ public final class ClassFinder { * @param annotations - required annotations * * @return List containing discovered classes + * @throws IOException when scanning classes fails */ public static List<String> findAnnotatedClasses(String[] strPathsOrJars, final Class<? extends Annotation>[] annotations) @@ -254,6 +264,7 @@ public final class ClassFinder { * @param annotations - true if classnames are annotations * * @return List containing discovered classes + * @throws IOException when scanning classes fails */ public static List<String> findClassesThatExtend(String[] searchPathsOrJars, final Class<?>[] classNames, final boolean innerClasses, 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=1649126&r1=1649125&r2=1649126&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 Fri Jan 2 21:13:05 2015 @@ -124,12 +124,19 @@ public class UrlConfigGui extends JPanel private boolean showRawBodyPane; + /** + * Constructor which is setup to show HTTP implementation, raw body pane and + * sampler fields. + */ public UrlConfigGui() { this(true); } /** + * Constructor which is setup to show HTTP implementation and raw body pane. + * * @param showSamplerFields + * flag whether sampler fields should be shown. */ public UrlConfigGui(boolean showSamplerFields) { this(showSamplerFields, true, true); @@ -137,8 +144,11 @@ public class UrlConfigGui extends JPanel /** * @param showSamplerFields - * @param showImplementation Show HTTP Implementation - * @param showRawBodyPane + * flag whether sampler fields should be shown + * @param showImplementation + * Show HTTP Implementation + * @param showRawBodyPane + * flag whether the raw body pane should be shown */ public UrlConfigGui(boolean showSamplerFields, boolean showImplementation, boolean showRawBodyPane) { notConfigOnly=showSamplerFields; @@ -190,7 +200,7 @@ public class UrlConfigGui extends JPanel /** * Save the GUI values in the sampler. * - * @param element + * @param element {@link TestElement} to modify */ public void modifyTestElement(TestElement element) { boolean useRaw = postContentTabbedPane.getSelectedIndex()==TAB_RAW_BODY; @@ -637,8 +647,15 @@ public class UrlConfigGui extends JPanel public void setSelectedIndex(int index) { setSelectedIndex(index, true); } + /** * Apply some check rules if check is true + * + * @param index + * index to select + * @param check + * flag whether to perform checks before setting the selected + * index */ public void setSelectedIndex(int index, boolean check) { int oldSelectedIndex = getSelectedIndex(); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CacheManager.java Fri Jan 2 21:13:05 2015 @@ -134,10 +134,15 @@ public class CacheManager extends Config } /** - * Save the Last-Modified, Etag, and Expires headers if the result is cacheable. - * Version for Commons HttpClient implementation. + * Save the Last-Modified, Etag, and Expires headers if the result is + * cacheable. Version for Commons HttpClient implementation. + * * @param method - * @param res result + * {@link HttpMethod} to get header information from + * @param res + * result to decide if result is cacheable + * @throws URIException + * if extraction of the the uri from <code>method</code> fails */ public void saveDetails(HttpMethod method, HTTPSampleResult res) throws URIException{ if (isCacheable(res)){ @@ -152,10 +157,13 @@ public class CacheManager extends Config } /** - * Save the Last-Modified, Etag, and Expires headers if the result is cacheable. - * Version for Apache HttpClient implementation. + * Save the Last-Modified, Etag, and Expires headers if the result is + * cacheable. Version for Apache HttpClient implementation. + * * @param method - * @param res result + * {@link HttpResponse} to extract header information from + * @param res + * result to decide if result is cacheable */ public void saveDetails(HttpResponse method, HTTPSampleResult res) { if (isCacheable(res)){ Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieHandler.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieHandler.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieHandler.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieHandler.java Fri Jan 2 21:13:05 2015 @@ -43,6 +43,7 @@ public interface CookieHandler { * @param cookiesCP {@link CollectionProperty} of {@link Cookie} * @param url * URL of the request to which the returned header will be added. + * @param allowVariableCookie flag whether to allow jmeter variables in cookie values * @return the value string for the cookie header (goes after "Cookie: "). */ String getCookieHeaderForURL(CollectionProperty cookiesCP, URL url, Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieManager.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieManager.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieManager.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/CookieManager.java Fri Jan 2 21:13:05 2015 @@ -153,7 +153,15 @@ public class CookieManager extends Confi /** * Save the static cookie data to a file. + * <p> * Cookies are only taken from the GUI - runtime cookies are not included. + * + * @param authFile + * name of the file to store the cookies into. If the name is + * relative, the system property <code>user.dir</code> will be + * prepended + * @throws IOException + * when writing to that file fails */ public void save(String authFile) throws IOException { File file = new File(authFile); @@ -178,6 +186,13 @@ public class CookieManager extends Confi /** * Add cookie data from a file. + * + * @param cookieFile + * name of the file to read the cookies from. If the name is + * relative, the system property <code>user.dir</code> will be + * prepended + * @throws IOException + * if reading the file fails */ public void addFile(String cookieFile) throws IOException { File file = new File(cookieFile); @@ -263,6 +278,8 @@ public class CookieManager extends Confi /** * Add a cookie. + * + * @param c cookie to be added */ public void add(Cookie c) { String cv = c.getValue(); @@ -304,6 +321,8 @@ public class CookieManager extends Confi /** * Remove a cookie. + * + * @param index index of the cookie to remove */ public void remove(int index) {// TODO not used by GUI getCookies().remove(index); @@ -311,6 +330,9 @@ public class CookieManager extends Confi /** * Return the cookie at index i. + * + * @param i index of the cookie to get + * @return cookie at index <code>i</code> */ public Cookie get(int i) {// Only used by GUI return (Cookie) getCookies().get(i).getObjectValue(); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/DNSCacheManager.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/DNSCacheManager.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/DNSCacheManager.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/DNSCacheManager.java Fri Jan 2 21:13:05 2015 @@ -219,6 +219,8 @@ public class DNSCacheManager extends Con /** * Clean DNS cache each iteration * + * @param clear + * flag whether DNS cache should be cleared on each iteration */ public void setClearEachIteration(boolean clear) { setProperty(new BooleanProperty(CLEAR_CACHE_EACH_ITER, clear)); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC3CookieHandler.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC3CookieHandler.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC3CookieHandler.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HC3CookieHandler.java Fri Jan 2 21:13:05 2015 @@ -39,7 +39,9 @@ public class HC3CookieHandler implements private final transient CookieSpec cookieSpec; /** - * + * @param policy + * cookie policy to which to conform (see + * {@link CookiePolicy#getCookieSpec(String)} */ public HC3CookieHandler(String policy) { super(); @@ -68,7 +70,9 @@ public class HC3CookieHandler implements /** * Get array of valid HttpClient cookies for the URL * + * @param cookiesCP cookies to consider * @param url the target URL + * @param allowVariableCookie flag whether to allow jmeter variables in cookie values * @return array of HttpClient cookies * */ Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Header.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Header.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Header.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/Header.java Fri Jan 2 21:13:05 2015 @@ -37,14 +37,19 @@ public class Header extends AbstractTest private static final String VALUE = "Header.value"; //$NON-NLS-1$ /** - * Create the header. + * Create the header. Uses an empty name and value as default */ public Header() { this("", ""); //$NON-NLS-1$ $NON-NLS-2$ } /** - * Create the coookie. + * Create the header. + * + * @param name + * name of the header + * @param value + * name of the header */ public Header(String name, String value) { this.setName(name); @@ -60,6 +65,8 @@ public class Header extends AbstractTest /** * Get the name for this object. + * + * @return the name of this header */ @Override public String getName() { @@ -68,6 +75,8 @@ public class Header extends AbstractTest /** * Set the name for this object. + * + * @param name the name of this header */ @Override public void setName(String name) { @@ -76,6 +85,8 @@ public class Header extends AbstractTest /** * Get the value for this object. + * + * @return the value of this header */ public String getValue() { return getPropertyAsString(VALUE); @@ -83,6 +94,8 @@ public class Header extends AbstractTest /** * Set the value for this object. + * + * @param value the value of this header */ public void setValue(String value) { this.setProperty(VALUE, value); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HeaderManager.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HeaderManager.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HeaderManager.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/HeaderManager.java Fri Jan 2 21:13:05 2015 @@ -100,6 +100,12 @@ public class HeaderManager extends Confi /** * Save the header data to a file. + * + * @param headFile + * name of the file to store headers into. If name is relative + * the system property <code>user.dir</code> will be prepended + * @throws IOException + * if writing the headers fails */ public void save(String headFile) throws IOException { File file = new File(headFile); @@ -121,6 +127,12 @@ public class HeaderManager extends Confi /** * Add header data from a file. + * + * @param headerFile + * name of the file to read headers from. If name is relative the + * system property <code>user.dir</code> will be prepended + * @throws IOException + * if reading headers fails */ public void addFile(String headerFile) throws IOException { File file = new File(headerFile); @@ -157,6 +169,8 @@ public class HeaderManager extends Confi /** * Add a header. + * + * @param h {@link Header} to add */ public void add(Header h) { getHeaders().addItem(h); @@ -171,6 +185,8 @@ public class HeaderManager extends Confi /** * Remove a header. + * + * @param index index from the header to remove */ public void remove(int index) { getHeaders().remove(index); @@ -178,6 +194,8 @@ public class HeaderManager extends Confi /** * Return the number of headers. + * + * @return number of headers */ public int size() { return getHeaders().size(); @@ -185,6 +203,10 @@ public class HeaderManager extends Confi /** * Return the header at index i. + * + * @param i + * index of the header to get + * @return {@link Header} at index <code>i</code> */ public Header get(int i) { return (Header) getHeaders().get(i).getObjectValue(); @@ -221,10 +243,10 @@ public class HeaderManager extends Confi /** * Set the SOAPHeader with the SOAPHTTPConnection object. We may or may not - * want to rename this to setHeaderObject(Object). Concievably, other + * want to rename this to setHeaderObject(Object). Conceivably, other * samplers may need this kind of functionality. 1-29-04 Peter Lin * - * @param header + * @param header soap header */ public void setSOAPHeader(Object header) { this.SOAPHeader = header; @@ -232,9 +254,16 @@ public class HeaderManager extends Confi /** * Merge the attributes with a another HeaderManager's attributes. - * @param element The object to be merged with - * @param preferLocalValues When both objects have a value for the - * same attribute, this flag determines which value is preferresd. + * + * @param element + * The object to be merged with + * @param preferLocalValues + * When both objects have a value for the same attribute, this + * flag determines which value is preferred. + * @return merged HeaderManager + * @throws IllegalArgumentException + * if <code>element</code> is not an instance of + * {@link HeaderManager} */ public HeaderManager merge(TestElement element, boolean preferLocalValues) { if (!(element instanceof HeaderManager)) { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/gui/WebServiceSamplerGui.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/gui/WebServiceSamplerGui.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/gui/WebServiceSamplerGui.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/control/gui/WebServiceSamplerGui.java Fri Jan 2 21:13:05 2015 @@ -447,7 +447,10 @@ public class WebServiceSamplerGui extend * easily replace it with a different WSDL driver later on. * * @param url - * @param silent + * URL to the WSDL + * @param silent + * flag whether errors parsing the WSDL should be shown to the + * user. If <code>true</code> errors will be silently ignored * @return array of web methods */ public String[] browseWSDL(String url, boolean silent) { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/gui/HTTPFileArgsPanel.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/gui/HTTPFileArgsPanel.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/gui/HTTPFileArgsPanel.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/gui/HTTPFileArgsPanel.java Fri Jan 2 21:13:05 2015 @@ -149,7 +149,7 @@ public class HTTPFileArgsPanel extends J /** * Save the GUI data in the HTTPSamplerBase element. * - * @param testElement + * @param testElement {@link TestElement} to modify */ public void modifyTestElement(TestElement testElement) { GuiUtils.stopTableEditing(table); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserSequence.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserSequence.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserSequence.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/modifier/UserSequence.java Fri Jan 2 21:13:05 2015 @@ -57,6 +57,8 @@ public class UserSequence implements Ser * <P> * ie a Set of Mapped "parameter names and parameter values" for each user * to be loaded into the sequencer. + * + * @param allUsers users and parameter data to be used */ public UserSequence(List<Map<String, String>> allUsers) { this.allUsers = allUsers; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HTMLParser.java Fri Jan 2 21:13:05 2015 @@ -138,6 +138,7 @@ public abstract class HTMLParser { * Base URL from which the HTML code was obtained * @param encoding Charset * @return an Iterator for the resource URLs + * @throws HTMLParseException when parsing the <code>html</code> fails */ public Iterator<URL> getEmbeddedResourceURLs(String userAgent, byte[] html, URL baseUrl, String encoding) throws HTMLParseException { // The Set is used to ignore duplicated binary files. @@ -173,7 +174,7 @@ public abstract class HTMLParser { * Malformed URLs can be reported to the caller by having the Iterator * return the corresponding RL String. Overall problems parsing the html * should be reported by throwing an HTMLParseException. - * + * <p> * N.B. The Iterator returns URLs, but the Collection will contain objects * of class URLString. * @@ -187,6 +188,7 @@ public abstract class HTMLParser { * URLCollection * @param encoding Charset * @return an Iterator for the resource URLs + * @throws HTMLParseException when parsing the <code>html</code> fails */ public abstract Iterator<URL> getEmbeddedResourceURLs(String userAgent, byte[] html, URL baseUrl, URLCollection coll, String encoding) throws HTMLParseException; @@ -195,7 +197,7 @@ public abstract class HTMLParser { * Get the URLs for all the resources that a browser would automatically * download following the download of the HTML content, that is: images, * stylesheets, javascript files, applets, etc... - * + * <p> * N.B. The Iterator returns URLs, but the Collection will contain objects * of class URLString. * @@ -209,6 +211,7 @@ public abstract class HTMLParser { * Collection - will contain URLString objects, not URLs * @param encoding Charset * @return an Iterator for the resource URLs + * @throws HTMLParseException when parsing the <code>html</code> fails */ public Iterator<URL> getEmbeddedResourceURLs(String userAgent, byte[] html, URL baseUrl, Collection<URLString> coll, String encoding) throws HTMLParseException { return getEmbeddedResourceURLs(userAgent, html, baseUrl, new URLCollection(coll), encoding); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HtmlParsingUtils.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HtmlParsingUtils.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HtmlParsingUtils.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/HtmlParsingUtils.java Fri Jan 2 21:13:05 2015 @@ -254,6 +254,17 @@ public final class HtmlParsingUtils { * Create a new Sampler based on an HREF string plus a contextual URL * object. Given that an HREF string might be of three possible forms, some * processing is required. + * + * @param parsedUrlString + * the url from the href + * @param context + * the context in which the href was found. This is used to + * extract url information that might be missing in + * <code>parsedUrlString</code> + * @return sampler with filled in information about the fully parsed url + * @throws MalformedURLException + * when the given url (<code>parsedUrlString</code> plus + * <code>context</code> is malformed) */ public static HTTPSamplerBase createUrlFromAnchor(String parsedUrlString, URL context) throws MalformedURLException { if (log.isDebugEnabled()) { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/JsoupBasedHtmlParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/JsoupBasedHtmlParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/JsoupBasedHtmlParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/JsoupBasedHtmlParser.java Fri Jan 2 21:13:05 2015 @@ -57,8 +57,8 @@ public class JsoupBasedHtmlParser extend private URLPointer baseUrl; /** - * @param baseUrl - * @param urls + * @param baseUrl base url to extract possibly missing information from urls found in <code>urls</code> + * @param urls collection of urls to consider */ public JMeterNodeVisitor(final URLPointer baseUrl, URLCollection urls) { this.urls = urls; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/LagartoBasedHtmlParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/LagartoBasedHtmlParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/LagartoBasedHtmlParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/LagartoBasedHtmlParser.java Fri Jan 2 21:13:05 2015 @@ -68,9 +68,9 @@ public class LagartoBasedHtmlParser exte private Stack<Boolean> enabled = new Stack<Boolean>(); /** - * @param baseUrl - * @param urls - * @param ieVersion + * @param baseUrl base url to add possibly missing information to urls found in <code>urls</code> + * @param urls collection of urls to consider + * @param ieVersion version number of IE to emulate */ public JMeterTagVisitor(final URLPointer baseUrl, URLCollection urls, Float ieVersion) { this.urls = urls; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/RegexpHTMLParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/RegexpHTMLParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/RegexpHTMLParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/RegexpHTMLParser.java Fri Jan 2 21:13:05 2015 @@ -141,7 +141,6 @@ class RegexpHTMLParser extends HTMLParse /** * {@inheritDoc} - * @throws HTMLParseException */ @Override public Iterator<URL> getEmbeddedResourceURLs(String userAgent, byte[] html, URL baseUrl, URLCollection urls, String encoding) throws HTMLParseException { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/URLCollection.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/URLCollection.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/URLCollection.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/parser/URLCollection.java Fri Jan 2 21:13:05 2015 @@ -30,10 +30,10 @@ import org.apache.log.Logger; /** * Collection class designed for handling URLs - * + * <p> * Before a URL is added to the collection, it is wrapped in a URLString class. * The iterator unwraps the URL before return. - * + * <p> * N.B. Designed for use by HTMLParser, so is not a full implementation - e.g. * does not support remove() * @@ -45,6 +45,7 @@ public class URLCollection { /** * Creates a new URLCollection from an existing Collection * + * @param c collection to start with */ public URLCollection(Collection<URLString> c) { coll = c; @@ -63,12 +64,15 @@ public class URLCollection { } /** - * Convenience method for adding URLs to the collection If the url parameter - * is null, empty or URL is malformed, nothing is done + * Convenience method for adding URLs to the collection. If the url + * parameter is <code>null</code>, empty or URL is malformed, nothing is + * done * * @param url * String, may be null or empty * @param baseUrl + * base for <code>url</code> to add information, which might be + * missing in <code>url</code> * @return boolean condition returned by the add() method of the underlying * collection */ Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Daemon.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Daemon.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Daemon.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/Daemon.java Fri Jan 2 21:13:05 2015 @@ -22,6 +22,7 @@ import java.io.IOException; import java.io.InterruptedIOException; import java.net.ServerSocket; import java.net.Socket; +import java.net.SocketException; import java.util.Collections; import java.util.HashMap; import java.util.Map; @@ -74,7 +75,9 @@ public class Daemon extends Thread imple * @param target * the target which will receive the generated JMeter test * components. - * @throws IOException + * @throws IOException if an I/O error occurs opening the socket + * @throws IllegalArgumentException if <code>port</code> is outside the allowed range from <code>0</code> to <code>65535</code> + * @throws SocketException when something is wrong on the underlying protocol layer */ public Daemon(int port, ProxyControl target) throws IOException { this(port, target, Proxy.class); @@ -92,7 +95,9 @@ public class Daemon extends Thread imple * @param proxyClass * the proxy class to use to handle individual requests. This * class must be the {@link Proxy} class or a subclass. - * @throws IOException + * @throws IOException if an I/O error occurs opening the socket + * @throws IllegalArgumentException if <code>port</code> is outside the allowed range from <code>0</code> to <code>65535</code> + * @throws SocketException when something is wrong on the underlying protocol layer */ public Daemon(int port, ProxyControl target, Class<? extends Proxy> proxyClass) throws IOException { super("HTTP Proxy Daemon"); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/FormCharSetFinder.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/FormCharSetFinder.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/FormCharSetFinder.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/FormCharSetFinder.java Fri Jan 2 21:13:05 2015 @@ -53,7 +53,7 @@ public class FormCharSetFinder { * @param html the html to parse for form encodings * @param formEncodings the Map where form encodings should be added * @param pageEncoding the encoding used for the whole page - * @throws HTMLParseException + * @throws HTMLParseException when parsing the <code>html</code> fails */ public void addFormActionsAndCharSet(String html, Map<String, String> formEncodings, String pageEncoding) throws HTMLParseException { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/HttpRequestHdr.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/HttpRequestHdr.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/HttpRequestHdr.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/proxy/HttpRequestHdr.java Fri Jan 2 21:13:05 2015 @@ -105,6 +105,7 @@ public class HttpRequestHdr { * @param in * the stream to parse. * @return array of bytes from client. + * @throws IOException when reading the input stream fails */ public byte[] parse(InputStream in) throws IOException { boolean inHeaders = true; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/AccessLogSampler.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/AccessLogSampler.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/AccessLogSampler.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/AccessLogSampler.java Fri Jan 2 21:13:05 2015 @@ -85,6 +85,8 @@ public class AccessLogSampler extends HT /** * Set the path where XML messages are stored for random selection. + * + * @param path path where to store XML messages */ public void setLogFile(String path) { logFile = path; @@ -93,6 +95,8 @@ public class AccessLogSampler extends HT /** * Get the path where XML messages are stored. this is the directory where * JMeter will randomly select a file. + * + * @return path where XML messages are stored */ public String getLogFile() { return logFile; @@ -121,6 +125,8 @@ public class AccessLogSampler extends HT /** * sample gets a new HTTPSampler from the generator and calls it's sample() * method. + * + * @return newly generated and called sample */ public SampleResult sampleWithParser() { initFilter(); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java Fri Jan 2 21:13:05 2015 @@ -556,6 +556,9 @@ public abstract class HTTPSamplerBase ex /** * Add an argument which has already been encoded + * + * @param name name of the argument + * @param value value of the argument */ public void addEncodedArgument(String name, String value) { this.addEncodedArgument(name, value, ARG_VAL_SEP); @@ -923,7 +926,7 @@ public abstract class HTTPSamplerBase ex * </p> * * @return The URL to be requested by this sampler. - * @throws MalformedURLException + * @throws MalformedURLException if url is malformed */ public URL getUrl() throws MalformedURLException { StringBuilder pathAndQuery = new StringBuilder(100); @@ -1692,16 +1695,16 @@ public abstract class HTTPSamplerBase ex /** * Read response from the input stream, converting to MD5 digest if the useMD5 property is set. - * + * <p> * For the MD5 case, the result byte count is set to the size of the original response. - * + * <p> * Closes the inputStream * - * @param sampleResult - * @param in input stream + * @param sampleResult sample to store information about the response into + * @param in input stream from which to read the response * @param length expected input length or zero * @return the response or the MD5 of the response - * @throws IOException + * @throws IOException if reading the result fails */ public byte[] readResponse(SampleResult sampleResult, InputStream in, int length) throws IOException { try { @@ -1759,18 +1762,20 @@ public abstract class HTTPSamplerBase ex /** * JMeter 2.3.1 and earlier only had fields for one file on the GUI: - * - FILE_NAME - * - FILE_FIELD - * - MIMETYPE + * <ul> + * <li>FILE_NAME</li> + * <li>FILE_FIELD</li> + * <li>MIMETYPE</li> + * </ul> * These were stored in their own individual properties. - * + * <p> * Version 2.3.3 introduced a list of files, each with their own path, name and mimetype. - * + * <p> * In order to maintain backwards compatibility of test plans, the 3 original properties * were retained; additional file entries are stored in an HTTPFileArgs class. * The HTTPFileArgs class was only present if there is more than 1 file; this means that * such test plans are backward compatible. - * + * <p> * Versions after 2.3.4 dispense with the original set of 3 properties. * Test plans that use them are converted to use a single HTTPFileArgs list. * @@ -1808,6 +1813,8 @@ public abstract class HTTPSamplerBase ex /** * set IP source to use - does not apply to Java HTTP implementation currently + * + * @param value IP source to use */ public void setIpSource(String value) { setProperty(IP_SOURCE, value, ""); @@ -1815,6 +1822,8 @@ public abstract class HTTPSamplerBase ex /** * get IP source to use - does not apply to Java HTTP implementation currently + * + * @return IP source to use */ public String getIpSource() { return getPropertyAsString(IP_SOURCE,""); @@ -1822,6 +1831,8 @@ public abstract class HTTPSamplerBase ex /** * set IP/address source type to use + * + * @param value type of the IP/address source */ public void setIpSourceType(int value) { setProperty(IP_SOURCE_TYPE, value, SOURCE_TYPE_DEFAULT); @@ -1948,8 +1959,8 @@ public abstract class HTTPSamplerBase ex private final HTTPSampleResult result; private final CollectionProperty cookies; /** - * @param result - * @param cookies + * @param result {@link HTTPSampleResult} to hold + * @param cookies cookies to hold */ public AsynSamplerResultHolder(HTTPSampleResult result, CollectionProperty cookies) { super(); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HttpWebdav.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HttpWebdav.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HttpWebdav.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HttpWebdav.java Fri Jan 2 21:13:05 2015 @@ -46,8 +46,8 @@ public final class HttpWebdav extends Ht /** * - * @param davMethod - * @param uri + * @param davMethod method to use (has to be a Webdav method as identified by {@link #isWebdavMethod(String)}) + * @param uri {@link URI} to use */ public HttpWebdav(final String davMethod, final URI uri) { super(); @@ -62,7 +62,7 @@ public final class HttpWebdav extends Ht /** * @param method Http Method - * @return true if method is a Webdav one + * @return <code>true</code> if method is a Webdav one */ public static boolean isWebdavMethod(String method) { return WEBDAV_METHODS.contains(method); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/PostWriter.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/PostWriter.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/PostWriter.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/PostWriter.java Fri Jan 2 21:13:05 2015 @@ -44,7 +44,7 @@ public class PostWriter { private static final String DASH_DASH = "--"; // $NON-NLS-1$ private static final byte[] DASH_DASH_BYTES = {'-', '-'}; - /** The bounday string between multiparts */ + /** The boundary string between multiparts */ protected static final String BOUNDARY = "---------------------------7d159c1302d0y0"; // $NON-NLS-1$ private static final byte[] CRLF = { 0x0d, 0x0A }; @@ -79,8 +79,13 @@ public class PostWriter { /** * Send POST data from Entry to the open connection. * - * @return the post body sent. Actual file content is not returned, it - * is just shown as a placeholder text "actual file content" + * @param connection + * the open connection to use for sending data + * @param sampler + * sampler to get information about what to send + * @return the post body sent. Actual file content is not returned, it is + * just shown as a placeholder text "actual file content" + * @throws IOException when writing data fails */ public String sendPostData(URLConnection connection, HTTPSamplerBase sampler) throws IOException { // Buffer to hold the post body, except file content Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/SoapSampler.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/SoapSampler.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/SoapSampler.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/SoapSampler.java Fri Jan 2 21:13:05 2015 @@ -82,7 +82,7 @@ public class SoapSampler extends HTTPSam * it's kinda obvious, but we state it anyways. Set the xml file with a * string path. * - * @param filename + * @param filename path to the xml file */ public void setXmlFile(String filename) { setProperty(XML_DATA_FILE, filename); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/WebServiceSampler.java Fri Jan 2 21:13:05 2015 @@ -72,7 +72,7 @@ public class WebServiceSampler extends H private static final long serialVersionUID = 240L; - //+ JMX file attribut names - do not change! + //+ JMX file attribute names - do not change! private static final String XML_DATA = "HTTPSamper.xml_data"; //$NON-NLS-1$ private static final String SOAP_ACTION = "Soap.Action"; //$NON-NLS-1$ @@ -96,7 +96,7 @@ public class WebServiceSampler extends H private static final String WSDL_URL = "WebserviceSampler.wsdl_url"; //$NON-NLS-1$ private static final String TIMEOUT = "WebserviceSampler.timeout"; //$NON-NLS-1$ - //- JMX file attribut names - do not change! + //- JMX file attribute names - do not change! private static final String PROXY_USER = JMeterUtils.getPropDefault(JMeter.HTTP_PROXY_USER,""); // $NON-NLS-1$ @@ -117,14 +117,18 @@ public class WebServiceSampler extends H /** * Set the path where XML messages are stored for random selection. + * + * @param path where XML messages are stored */ public void setXmlPathLoc(String path) { setProperty(XML_PATH_LOC, path); } /** - * Get the path where XML messages are stored. this is the directory where + * Get the path where XML messages are stored. This is the directory where * JMeter will randomly select a file. + * + * @return path where XML messages are stored */ public String getXmlPathLoc() { return getPropertyAsString(XML_PATH_LOC); @@ -134,7 +138,7 @@ public class WebServiceSampler extends H * it's kinda obvious, but we state it anyways. Set the xml file with a * string path. * - * @param filename + * @param filename path to xml file */ public void setXmlFile(String filename) { setProperty(XML_DATA_FILE, filename); @@ -174,7 +178,7 @@ public class WebServiceSampler extends H /** * Set the XML data. * - * @param data + * @param data xml data */ public void setXmlData(String data) { setProperty(XML_DATA, data); @@ -192,7 +196,7 @@ public class WebServiceSampler extends H /** * Set the soap action which should be in the form of an URN. * - * @param data + * @param data soap action */ public void setSoapAction(String data) { setProperty(SOAP_ACTION, data); @@ -210,7 +214,7 @@ public class WebServiceSampler extends H /** * Set the maintain session option. * - * @param maintainSession + * @param maintainSession flag whether to maintain a session */ public void setMaintainSession(boolean maintainSession) { setProperty(MAINTAIN_SESSION, maintainSession, MAINTAIN_SESSION_DEFAULT); @@ -219,7 +223,7 @@ public class WebServiceSampler extends H /** * Get the maintain session option. * - * @return boolean cache + * @return flag whether to maintain a session */ public boolean getMaintainSession() { return getPropertyAsBoolean(MAINTAIN_SESSION, MAINTAIN_SESSION_DEFAULT); @@ -228,7 +232,7 @@ public class WebServiceSampler extends H /** * Set the memory cache. * - * @param cache + * @param cache flag whether to use the memory cache */ public void setMemoryCache(boolean cache) { setProperty(MEMORY_CACHE, String.valueOf(cache)); @@ -237,7 +241,7 @@ public class WebServiceSampler extends H /** * Get the memory cache. * - * @return boolean cache + * @return flag whether to use the memory cache */ public boolean getMemoryCache() { return getPropertyAsBoolean(MEMORY_CACHE); @@ -247,6 +251,7 @@ public class WebServiceSampler extends H * Set whether the sampler should read the response or not. * * @param read + * flag whether the response should be read */ public void setReadResponse(boolean read) { setProperty(READ_RESPONSE, String.valueOf(read)); @@ -255,7 +260,7 @@ public class WebServiceSampler extends H /** * Return whether or not to read the response. * - * @return boolean + * @return flag whether the response should be read */ public boolean getReadResponse() { return this.getPropertyAsBoolean(READ_RESPONSE); @@ -264,7 +269,7 @@ public class WebServiceSampler extends H /** * Set whether or not to use a proxy * - * @param proxy + * @param proxy flag whether to use a proxy */ public void setUseProxy(boolean proxy) { setProperty(USE_PROXY, String.valueOf(proxy)); @@ -273,7 +278,7 @@ public class WebServiceSampler extends H /** * Return whether or not to use proxy * - * @return true if should use proxy + * @return <code>true</code> if a proxy should be used */ public boolean getUseProxy() { return this.getPropertyAsBoolean(USE_PROXY); @@ -282,7 +287,7 @@ public class WebServiceSampler extends H /** * Set the proxy hostname * - * @param host + * @param host the hostname of the proxy */ public void setProxyHost(String host) { setProperty(PROXY_HOST, host); @@ -302,7 +307,7 @@ public class WebServiceSampler extends H /** * Set the proxy port * - * @param port + * @param port the port of the proxy */ public void setProxyPort(String port) { setProperty(PROXY_PORT, port); @@ -320,7 +325,7 @@ public class WebServiceSampler extends H /** * - * @param url + * @param url the URL of the WSDL */ public void setWsdlURL(String url) { this.setProperty(WSDL_URL, url); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPArgument.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPArgument.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPArgument.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPArgument.java Fri Jan 2 21:13:05 2015 @@ -50,6 +50,15 @@ public class HTTPArgument extends Argume /** * Constructor for the Argument object. + * <p> + * The value is assumed to be not encoded. + * + * @param name + * name of the paramter + * @param value + * value of the parameter + * @param metadata + * the separator to use between name and value */ public HTTPArgument(String name, String value, String metadata) { this(name, value, false); @@ -85,11 +94,27 @@ public class HTTPArgument extends Argume /** * Constructor for the Argument object. + * <p> + * The value is assumed to be not encoded. + * + * @param name + * name of the parameter + * @param value + * value of the parameter */ public HTTPArgument(String name, String value) { this(name, value, false); } + /** + * @param name + * name of the parameter + * @param value + * value of the parameter + * @param alreadyEncoded + * <code>true</code> if the value is already encoded, in which + * case they are decoded before storage + */ public HTTPArgument(String name, String value, boolean alreadyEncoded) { // We assume the argument value is encoded according to the HTTP spec, i.e. UTF-8 this(name, value, alreadyEncoded, EncoderCache.URL_ARGUMENT_ENCODING); @@ -127,6 +152,18 @@ public class HTTPArgument extends Argume setMetaData("="); } + /** + * Construct a new HTTPArgument instance + * + * @param name + * the name of the parameter + * @param value + * the value of the parameter + * @param metaData + * the separator to use between name and value + * @param alreadyEncoded + * true if the name and value is already encoded + */ public HTTPArgument(String name, String value, String metaData, boolean alreadyEncoded) { // We assume the argument value is encoded according to the HTTP spec, i.e. UTF-8 this(name, value, metaData, alreadyEncoded, EncoderCache.URL_ARGUMENT_ENCODING); @@ -190,7 +227,7 @@ public class HTTPArgument extends Argume * * @param contentEncoding the encoding to use when encoding the argument value * @return the argument value encoded in the specified encoding - * @throws UnsupportedEncodingException + * @throws UnsupportedEncodingException of the encoding is not supported */ public String getEncodedValue(String contentEncoding) throws UnsupportedEncodingException { if (isAlwaysEncoded()) { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPFileArg.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPFileArg.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPFileArg.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPFileArg.java Fri Jan 2 21:13:05 2015 @@ -55,6 +55,11 @@ public class HTTPFileArg extends Abstrac /** * Constructor for the HTTPFileArg object with given path. + * + * @param path + * path to the file to use + * @throws IllegalArgumentException + * if <code>path</code> is <code>null</code> */ public HTTPFileArg(String path) { this(path, "", ""); @@ -62,6 +67,15 @@ public class HTTPFileArg extends Abstrac /** * Constructor for the HTTPFileArg object with full information. + * + * @param path + * path of the file to use + * @param paramname + * name of the http parameter to use for the file + * @param mimetype + * mimetype of the file + * @throws IllegalArgumentException + * if any parameter is <code>null</code> */ public HTTPFileArg(String path, String paramname, String mimetype) { if (path == null || paramname == null || mimetype == null){ @@ -75,6 +89,15 @@ public class HTTPFileArg extends Abstrac /** * Constructor for the HTTPFileArg object with full information, * using existing properties + * + * @param path + * path of the file to use + * @param paramname + * name of the http parameter to use for the file + * @param mimetype + * mimetype of the file + * @throws IllegalArgumentException + * if any parameter is <code>null</code> */ public HTTPFileArg(JMeterProperty path, JMeterProperty paramname, JMeterProperty mimetype) { if (path == null || paramname == null || mimetype == null){ @@ -93,6 +116,12 @@ public class HTTPFileArg extends Abstrac /** * Copy Constructor. + * + * @param file + * {@link HTTPFileArg} to get information about the path, http + * parameter name and mimetype of the file + * @throws IllegalArgumentException + * if any of those retrieved information is <code>null</code> */ public HTTPFileArg(HTTPFileArg file) { this(file.getPath(), file.getParamName(), file.getMimeType()); @@ -170,6 +199,8 @@ public class HTTPFileArg extends Abstrac /** * Gets the saved body header for the HTTPFileArg object. + * + * @return saved body header */ public String getHeader() { return header; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/HTTPResultConverter.java Fri Jan 2 21:13:05 2015 @@ -49,7 +49,7 @@ public class HTTPResultConverter extends } /** - * @param arg0 + * @param arg0 the mapper */ public HTTPResultConverter(Mapper arg0) { super(arg0); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLException.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLException.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLException.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/WSDLException.java Fri Jan 2 21:13:05 2015 @@ -31,14 +31,14 @@ public class WSDLException extends Excep } /** - * @param message + * @param message detailed error message to include in exception */ public WSDLException(String message) { super(message); } /** - * @param exception + * @param exception exception to extract the detailed message from and include that message as detailed message in this exception */ public WSDLException(Exception exception) { super(exception.getMessage()); 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=1649126&r1=1649125&r2=1649126&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 Fri Jan 2 21:13:05 2015 @@ -84,11 +84,24 @@ public class WSDLHelper { /** * Default constructor takes a string URL + * + * @param url + * url to the wsdl + * @throws MalformedURLException + * if <code>url</code> is malformed */ public WSDLHelper(String url) throws MalformedURLException { this(url, null); } + /** + * @param url + * url to the wsdl + * @param auth + * {@link AuthManager} to use + * @throws MalformedURLException + * if <code>url</code> is malformed + */ public WSDLHelper(String url, AuthManager auth) throws MalformedURLException { WSDLURL = new URL(url); this.AUTH = auth; @@ -106,6 +119,8 @@ public class WSDLHelper { /** * Return the protocol from the URL. this is needed, so that HTTPS works * as expected. + * + * @return protocol extracted from url */ public String getProtocol() { return this.bindingURL.getProtocol(); @@ -113,6 +128,8 @@ public class WSDLHelper { /** * Return the host in the WSDL binding address + * + * @return host extracted from url */ public String getBindingHost() { return this.bindingURL.getHost(); @@ -120,6 +137,8 @@ public class WSDLHelper { /** * Return the path in the WSDL for the binding address + * + * @return path extracted from url */ public String getBindingPath() { return this.bindingURL.getPath(); @@ -127,6 +146,8 @@ public class WSDLHelper { /** * Return the port for the binding address + * + * @return port extracted from url */ public int getBindingPort() { return this.bindingURL.getPort(); @@ -216,6 +237,8 @@ public class WSDLHelper { * Call this method to retrieve the WSDL. This method must be called, * otherwise a connection to the URL won't be made and the stream won't be * parsed. + * + * @throws WSDLException when parsing fails */ public void parse() throws WSDLException { try { @@ -235,6 +258,8 @@ public class WSDLHelper { /** * Get a list of the web methods as a string array. + * + * @return list of web methods */ public String[] getWebMethods() { for (int idx = 0; idx < SOAPOPS.length; idx++) { @@ -266,6 +291,10 @@ public class WSDLHelper { /** * Return the soap action matching the operation name. + * + * @param key + * name of the operation + * @return associated action */ public String getSoapAction(String key) { return this.ACTIONS.get(key); @@ -273,6 +302,8 @@ public class WSDLHelper { /** * Get the wsdl document. + * + * @return wsdl document */ public Document getWSDLDocument() { return WSDLDOC; @@ -360,7 +391,7 @@ public class WSDLHelper { * Simple test for the class uses bidbuy.wsdl from Apache's soap driver * examples. * - * @param args + * @param args standard arguments for a main class (not used here) */ public static void main(String[] args) { try { Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Filter.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Filter.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Filter.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/Filter.java Fri Jan 2 21:13:05 2015 @@ -80,7 +80,12 @@ public interface Filter { * filtered or not. * * @param path - * @return boolean + * log line that should be checked if it should to be filtered + * out + * @param sampler + * {@link TestElement} in which the line would be added + * @return boolean <code>true</code> if line should be filtered out, + * <code>false</code> otherwise */ boolean isFiltered(String path,TestElement sampler); 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=1649126&r1=1649125&r2=1649126&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 Fri Jan 2 21:13:05 2015 @@ -118,6 +118,8 @@ public interface Generator { * method wouldn't return anything. If the generator is used by a control * element, it should return the correct Sampler class with the required * fields set. + * + * @return prefilled sampler */ Object generateRequest(); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/LogParser.java Fri Jan 2 21:13:05 2015 @@ -49,8 +49,9 @@ public interface LogParser { * 0 is returned. If the method is subsequently called again, it will * restart parsing at the beginning. * - * @param count - * @return int + * @param count max lines to parse, or <code>-1</code> for the entire file + * @param el {@link TestElement} to read lines into + * @return number of lines parsed */ int parseAndConfigure(int count, TestElement el); Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/OrderPreservingLogParser.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/OrderPreservingLogParser.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/OrderPreservingLogParser.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/OrderPreservingLogParser.java Fri Jan 2 21:13:05 2015 @@ -35,7 +35,7 @@ public class OrderPreservingLogParser ex * of lines parsed will depend the filter and number of lines in the log. * The method returns the actual lines parsed. * - * @param count + * @param count number of max lines to read * @return lines parsed */ @Override Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/StandardGenerator.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/StandardGenerator.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/StandardGenerator.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/util/accesslog/StandardGenerator.java Fri Jan 2 21:13:05 2015 @@ -84,7 +84,7 @@ public class StandardGenerator implement /** * - * @param file + * @param file name of a file (TODO seems not to be used anywhere) */ public StandardGenerator(String file) { FILENAME = file; 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=1649126&r1=1649125&r2=1649126&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 Jan 2 21:13:05 2015 @@ -130,7 +130,7 @@ public class TCLogParser implements LogP } /** - * @param source + * @param source name of the source file */ public TCLogParser(String source) { setSourceFile(source); @@ -159,6 +159,7 @@ public class TCLogParser implements LogP * default, the parser uses the file in the log. * * @param file + * flag whether to use the path from the log */ public void setUseParsedFile(boolean file) { this.useFILE = file; Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/visualizers/RequestViewHTTP.java URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/visualizers/RequestViewHTTP.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/visualizers/RequestViewHTTP.java (original) +++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/visualizers/RequestViewHTTP.java Fri Jan 2 21:13:05 2015 @@ -223,6 +223,7 @@ public class RequestViewHTTP implements /** * @param query + * query to parse for param and value pairs * @return Map params and Svalue */ //TODO: move to utils class (JMeterUtils?) Modified: jmeter/trunk/test/src/org/apache/jmeter/JMeterVersionTest.java URL: http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/JMeterVersionTest.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/test/src/org/apache/jmeter/JMeterVersionTest.java (original) +++ jmeter/trunk/test/src/org/apache/jmeter/JMeterVersionTest.java Fri Jan 2 21:13:05 2015 @@ -101,7 +101,7 @@ public class JMeterVersionTest extends J /** * Check eclipse.classpath contains the jars declared in build.properties - * @throws Exception + * @throws Exception if something fails */ public void testEclipse() throws Exception { final BufferedReader eclipse = new BufferedReader( Modified: jmeter/trunk/test/src/org/apache/jmeter/control/TestIfController.java URL: http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/control/TestIfController.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/test/src/org/apache/jmeter/control/TestIfController.java (original) +++ jmeter/trunk/test/src/org/apache/jmeter/control/TestIfController.java Fri Jan 2 21:13:05 2015 @@ -36,7 +36,7 @@ public class TestIfController extends JM /** * See Bug 56160 - * @throws Exception + * @throws Exception if something fails */ public void testStackOverflow() throws Exception { LoopController controller = new LoopController(); @@ -74,7 +74,7 @@ public class TestIfController extends JM /** * See Bug 53768 - * @throws Exception + * @throws Exception if something fails */ public void testBug53768() throws Exception { LoopController controller = new LoopController(); @@ -216,7 +216,7 @@ public class TestIfController extends JM /** * Test false return on sample3 (sample4 doesn't execute) - * @throws Exception + * @throws Exception if something fails */ public void testEvaluateAllChildrenWithoutSubController() throws Exception { LoopController controller = new LoopController(); @@ -253,7 +253,7 @@ public class TestIfController extends JM /** * test 2 loops with a sub generic controller (sample4 doesn't execute) - * @throws Exception + * @throws Exception if something fails */ public void testEvaluateAllChildrenWithSubController() throws Exception { LoopController controller = new LoopController(); Modified: jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestCookieManager.java URL: http://svn.apache.org/viewvc/jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestCookieManager.java?rev=1649126&r1=1649125&r2=1649126&view=diff ============================================================================== --- jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestCookieManager.java (original) +++ jmeter/trunk/test/src/org/apache/jmeter/protocol/http/control/TestCookieManager.java Fri Jan 2 21:13:05 2015 @@ -84,6 +84,8 @@ public class TestCookieManager extends J /** * Test that the cookie domain field is actually handled as browsers do * (i.e.: host X matches domain .X): + * + * @throws Exception if something fails */ public void testDomainHandling() throws Exception { URL url = new URL("http://jakarta.apache.org/"); @@ -103,6 +105,8 @@ public class TestCookieManager extends J /** * Test that we won't be tricked by similar host names (this was a past * bug, although it never got reported in the bug database): + * + * @throws Exception if something fails */ public void testSimilarHostNames() throws Exception { URL url = new URL("http://ache.org/"); @@ -199,6 +203,8 @@ public class TestCookieManager extends J /** Tests missing cookie path for a trivial URL fetch from the domain * Note that this fails prior to a fix for BUG 38256 + * + * @throws Exception if something fails */ public void testMissingPath0() throws Exception { URL url = new URL("http://d.e.f/goo.html"); @@ -210,6 +216,8 @@ public class TestCookieManager extends J /** Tests missing cookie path for a non-trivial URL fetch from the * domain. Note that this fails prior to a fix for BUG 38256 + * + * @throws Exception if something fails */ public void testMissingPath1() throws Exception { URL url = new URL("http://d.e.f/moo.html"); @@ -219,7 +227,10 @@ public class TestCookieManager extends J assertEquals("test=moo", s); } - /** Tests explicit root path with a trivial URL fetch from the domain */ + /** Tests explicit root path with a trivial URL fetch from the domain + * + * @throws Exception if something fails + */ public void testRootPath0() throws Exception { URL url = new URL("http://d.e.f/goo.html"); man.addCookieFromHeader("test=moo;path=/", url); @@ -228,7 +239,10 @@ public class TestCookieManager extends J assertEquals("test=moo", s); } - /** Tests explicit root path with a non-trivial URL fetch from the domain */ + /** Tests explicit root path with a non-trivial URL fetch from the domain + * + * @throws Exception if something fails + */ public void testRootPath1() throws Exception { URL url = new URL("http://d.e.f/moo.html"); man.addCookieFromHeader("test=moo;path=/", url);