Author: fschumacher
Date: Sun Nov 23 10:33:16 2014
New Revision: 1641171
URL: http://svn.apache.org/r1641171
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193
Modified:
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java
jmeter/trunk/src/components/org/apache/jmeter/control/CriticalSectionController.java
jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
jmeter/trunk/src/components/org/apache/jmeter/control/ModuleController.java
jmeter/trunk/src/components/org/apache/jmeter/extractor/HtmlExtractor.java
jmeter/trunk/src/components/org/apache/jmeter/extractor/RegexExtractor.java
Modified:
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
---
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java
(original)
+++
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/HTMLAssertionGui.java
Sun Nov 23 10:33:16 2014
@@ -149,6 +149,7 @@ public class HTMLAssertionGui extends Ab
/**
* Implements JMeterGUIComponent.clearGui
+ * {@inheritDoc}
*/
@Override
public void clearGui() {
@@ -166,8 +167,7 @@ public class HTMLAssertionGui extends Ab
/**
* Configures the associated test element.
- *
- * @param inElement
+ * {@inheritDoc}
*/
@Override
public void configure(TestElement inElement) {
@@ -265,7 +265,7 @@ public class HTMLAssertionGui extends Ab
/**
* This method is called if one of the threshold field looses the focus
*
- * @param inEvent
+ * @param inEvent The {@link FocusEvent} with detailed information about
the focus loss
*/
public void focusLost(FocusEvent inEvent) {
log.debug("HTMLAssertionGui.focusLost() called");
@@ -308,6 +308,9 @@ public class HTMLAssertionGui extends Ab
}
/**
+ * Method gets called when one of the threshold fields gains focus
+ *
+ * @param e The {@link FocusEvent} with detailed information about the
focus gain
* @see java.awt.event.FocusListener#focusGained(java.awt.event.FocusEvent)
*/
public void focusGained(FocusEvent e) {
Modified:
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
---
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java
(original)
+++
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/SizeAssertionGui.java
Sun Nov 23 10:33:16 2014
@@ -63,6 +63,9 @@ public class SizeAssertionGui extends Ab
private int execState; // store the operator
+ /**
+ * Simple Constructor which initializes the gui component
+ */
public SizeAssertionGui() {
init();
}
@@ -150,7 +153,18 @@ public class SizeAssertionGui extends Ab
}
/**
- * Set the state of the radio Button
+ * Set the state of the radio Button.
+ * <p>
+ * Allowed states are
+ * <ul>
+ * <li>{@link SizeAssertion#EQUAL}</li>
+ * <li>{@link SizeAssertion#NOTEQUAL}</li>
+ * <li>{@link SizeAssertion#GREATERTHAN}</li>
+ * <li>{@link SizeAssertion#LESSTHAN}</li>
+ * <li>{@link SizeAssertion#GREATERTHANEQUAL}</li>
+ * <li>{@link SizeAssertion#LESSTHANEQUAL}</li>
+ * </ul>
+ * @param state One of the allowed states
*/
public void setState(int state) {
if (state == SizeAssertion.EQUAL) {
@@ -176,6 +190,17 @@ public class SizeAssertionGui extends Ab
/**
* Get the state of the radio Button
+ * <p>
+ * Possible states are
+ * <ul>
+ * <li>{@link SizeAssertion#EQUAL}</li>
+ * <li>{@link SizeAssertion#NOTEQUAL}</li>
+ * <li>{@link SizeAssertion#GREATERTHAN}</li>
+ * <li>{@link SizeAssertion#LESSTHAN}</li>
+ * <li>{@link SizeAssertion#GREATERTHANEQUAL}</li>
+ * <li>{@link SizeAssertion#LESSTHANEQUAL}</li>
+ * </ul>
+ * @return The current state of the radio Button
*/
public int getState() {
return execState;
Modified:
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
---
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java
(original)
+++
jmeter/trunk/src/components/org/apache/jmeter/assertions/gui/XPathPanel.java
Sun Nov 23 10:33:16 2014
@@ -38,6 +38,10 @@ import org.apache.log.Logger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
+/**
+ * Gui component for representing a xpath expression
+ *
+ */
public class XPathPanel extends JPanel {
private static final long serialVersionUID = 240L;
@@ -74,6 +78,9 @@ public class XPathPanel extends JPanel {
setDefaultValues();
}
+ /**
+ * Set default values on this component
+ */
public void setDefaultValues() {
setXPath("/"); //$NON-NLS-1$
setNegated(false);
@@ -91,7 +98,7 @@ public class XPathPanel extends JPanel {
/**
* Set the string that will be used in the xpath evaluation
*
- * @param xpath
+ * @param xpath The string representing the xpath expression
*/
public void setXPath(String xpath) {
this.xpath.setInitialText(xpath);
@@ -109,7 +116,7 @@ public class XPathPanel extends JPanel {
/**
* Set this to true, if you want success when the xpath does not match.
*
- * @param negated
+ * @param negated Flag whether xpath match should be negated
*/
public void setNegated(boolean negated) {
this.negated.setSelected(negated);
@@ -146,6 +153,12 @@ public class XPathPanel extends JPanel {
return checkXPath;
}
+ /**
+ * Returns the current {@link JSyntaxTextArea} for the xpath expression, or
+ * creates a new one, if none is found.
+ *
+ * @return {@link JSyntaxTextArea} for the xpath expression
+ */
public JSyntaxTextArea getXPathField() {
if (xpath == null) {
xpath = new JSyntaxTextArea(20, 80);
Modified:
jmeter/trunk/src/components/org/apache/jmeter/control/CriticalSectionController.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/control/CriticalSectionController.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
---
jmeter/trunk/src/components/org/apache/jmeter/control/CriticalSectionController.java
(original)
+++
jmeter/trunk/src/components/org/apache/jmeter/control/CriticalSectionController.java
Sun Nov 23 10:33:16 2014
@@ -83,6 +83,7 @@ public class CriticalSectionController e
/**
* constructor
+ * @param name The name of this controller
*/
public CriticalSectionController(String name) {
super();
@@ -91,6 +92,7 @@ public class CriticalSectionController e
/**
* Condition Accessor - this is gonna be any string value
+ * @param name The name of the lock for this controller
*/
public void setLockName(String name) {
setProperty(new StringProperty(LOCK_NAME, name));
Modified:
jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
---
jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
(original)
+++
jmeter/trunk/src/components/org/apache/jmeter/control/IncludeController.java
Sun Nov 23 10:33:16 2014
@@ -84,7 +84,7 @@ public class IncludeController extends G
/**
* In the event an user wants to include an external JMX test plan
* the GUI would call this.
- * @param jmxfile
+ * @param jmxfile The path to the JMX test plan to include
*/
public void setIncludePath(String jmxfile) {
this.setProperty(INCLUDE_PATH,jmxfile);
Modified:
jmeter/trunk/src/components/org/apache/jmeter/control/ModuleController.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/control/ModuleController.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/control/ModuleController.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/control/ModuleController.java
Sun Nov 23 10:33:16 2014
@@ -128,8 +128,7 @@ public class ModuleController extends Ge
}
/**
- * Compute the replacement tree.
- * @param context
+ * {@inheritDoc}
*/
@Override
public void resolveReplacementSubTree(JMeterTreeNode context) {
@@ -159,8 +158,7 @@ public class ModuleController extends Ge
}
/**
- * Copies the controller's subelements into the execution tree
- *
+ * {@inheritDoc}
*/
@Override
public HashTree getReplacementSubTree() {
Modified:
jmeter/trunk/src/components/org/apache/jmeter/extractor/HtmlExtractor.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/extractor/HtmlExtractor.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/extractor/HtmlExtractor.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/extractor/HtmlExtractor.java
Sun Nov 23 10:33:16 2014
@@ -43,6 +43,10 @@ public class HtmlExtractor extends Abstr
public static final String EXTRACTOR_JODD = "JODD"; //$NON-NLS-1$
+ /**
+ * Get the possible extractor implementations
+ * @return Array containing the names of the possible extractors.
+ */
public static String[] getImplementations(){
return new String[]{EXTRACTOR_JSOUP,EXTRACTOR_JODD};
}
@@ -232,10 +236,21 @@ public class HtmlExtractor extends Abstr
}
+ /**
+ * Set the extractor. Has to be one of the list that can be obtained by
+ * {@link HtmlExtractor#getImplementations()}
+ *
+ * @param attribute
+ * The name of the extractor to be used
+ */
public void setExtractor(String attribute) {
setProperty(EXTRACTOR_IMPL, attribute);
}
+ /**
+ * Get the name of the currently configured extractor
+ * @return The name of the extractor currently used
+ */
public String getExtractor() {
return getPropertyAsString(EXTRACTOR_IMPL); // $NON-NLS-1$
}
@@ -267,9 +282,9 @@ public class HtmlExtractor extends Abstr
/**
* Set which Match to use. This can be any positive number, indicating the
- * exact match to use, or 0, which is interpreted as meaning random.
+ * exact match to use, or <code>0</code>, which is interpreted as meaning
random.
*
- * @param matchNumber
+ * @param matchNumber The number of the match to be used
*/
public void setMatchNumber(int matchNumber) {
setProperty(new IntegerProperty(MATCH_NUMBER, matchNumber));
@@ -290,12 +305,16 @@ public class HtmlExtractor extends Abstr
/**
* Sets the value of the variable if no matches are found
*
- * @param defaultValue
+ * @param defaultValue The default value for the variable
*/
public void setDefaultValue(String defaultValue) {
setProperty(DEFAULT, defaultValue);
}
+ /**
+ * Get the default value for the variable if no matches are found
+ * @return The default value for the variable
+ */
public String getDefaultValue() {
return getPropertyAsString(DEFAULT);
}
Modified:
jmeter/trunk/src/components/org/apache/jmeter/extractor/RegexExtractor.java
URL:
http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/extractor/RegexExtractor.java?rev=1641171&r1=1641170&r2=1641171&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/extractor/RegexExtractor.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/extractor/RegexExtractor.java
Sun Nov 23 10:33:16 2014
@@ -374,27 +374,46 @@ public class RegexExtractor extends Abst
return matches.get(entry - 1);
}
+ /**
+ * Set the regex to be used
+ * @param regex The string representation of the regex
+ */
public void setRegex(String regex) {
setProperty(REGEX, regex);
}
+ /**
+ * Get the regex which is to be used
+ * @return string representing the regex
+ */
public String getRegex() {
return getPropertyAsString(REGEX);
}
+ /**
+ * Set the prefix name of the variable to be used to store the regex
matches
+ * @param refName prefix of the variables to be used
+ */
public void setRefName(String refName) {
setProperty(REFNAME, refName);
}
+ /**
+ * Get the prefix name of the variable to be used to store the regex
matches
+ * @return The prefix of the variables to be used
+ */
public String getRefName() {
return getPropertyAsString(REFNAME);
}
/**
* Set which Match to use. This can be any positive number, indicating the
- * exact match to use, or 0, which is interpreted as meaning random.
+ * exact match to use, or <code>0</code>, which is interpreted as meaning
+ * random.
*
* @param matchNumber
+ * The number of the match to be used, or <code>0</code> if a
+ * random match should be used.
*/
public void setMatchNumber(int matchNumber) {
setProperty(new IntegerProperty(MATCH_NUMBER, matchNumber));
@@ -415,12 +434,18 @@ public class RegexExtractor extends Abst
/**
* Sets the value of the variable if no matches are found
*
- * @param defaultValue
+ * @param defaultValue The default value for the variable
*/
public void setDefaultValue(String defaultValue) {
setProperty(DEFAULT, defaultValue);
}
+ /**
+ * Get the default value for the variable, which should be used, if no
+ * matches are found
+ *
+ * @return The default value for the variable
+ */
public String getDefaultValue() {
return getPropertyAsString(DEFAULT);
}
