You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jmeter-dev@jakarta.apache.org by se...@apache.org on 2008/04/09 02:39:54 UTC
svn commit: r646154 [13/45] - in /jakarta/jmeter/trunk/docs/api: ./
org/apache/jmeter/ org/apache/jmeter/assertions/
org/apache/jmeter/assertions/gui/ org/apache/jmeter/config/
org/apache/jmeter/config/gui/ org/apache/jmeter/control/
org/apache/jmeter/...
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-summary.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-summary.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-summary.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-summary.html Tue Apr 8 17:39:07 2008
@@ -145,6 +145,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-tree.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-tree.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-tree.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/gui/package-tree.html Tue Apr 8 17:39:07 2008
@@ -154,6 +154,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-summary.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-summary.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-summary.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-summary.html Tue Apr 8 17:39:07 2008
@@ -170,6 +170,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-tree.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-tree.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-tree.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/extractor/package-tree.html Tue Apr 8 17:39:07 2008
@@ -155,6 +155,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/AbstractFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/AbstractFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/AbstractFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/AbstractFunction.html Tue Apr 8 17:39:07 2008
@@ -92,7 +92,7 @@
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></DD>
</DL>
<DL>
-<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/jmeter/functions/BeanShell.html" title="class in org.apache.jmeter.functions">BeanShell</A>, <A HREF="../../../../org/apache/jmeter/functions/CSVRead.html" title="class in org.apache.jmeter.functions">CSVRead</A>, <A HREF="../../../../org/apache/jmeter/functions/EvalFunction.html" title="class in org.apache.jmeter.functions">EvalFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/EvalVarFunction.html" title="class in org.apache.jmeter.functions">EvalVarFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/IntSum.html" title="class in org.apache.jmeter.functions">IntSum</A>, <A HREF="../../../../org/apache/jmeter/functions/IterationCounter.html" title="class in org.apache.jmeter.functions">IterationCounter</A>, <A HREF="../../../../org/apache/jmeter/functions/JavaScript.html" title="class in org.apache.jmeter.functions">JavaScript</A>, <A HREF="../../../../org/apache/jmeter/functions/J
exlFunction.html" title="class in org.apache.jmeter.functions">JexlFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/LogFunction.html" title="class in org.apache.jmeter.functions">LogFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/LogFunction2.html" title="class in org.apache.jmeter.functions">LogFunction2</A>, <A HREF="../../../../org/apache/jmeter/functions/MachineName.html" title="class in org.apache.jmeter.functions">MachineName</A>, <A HREF="../../../../org/apache/jmeter/functions/Property.html" title="class in org.apache.jmeter.functions">Property</A>, <A HREF="../../../../org/apache/jmeter/functions/Property2.html" title="class in org.apache.jmeter.functions">Property2</A>, <A HREF="../../../../org/apache/jmeter/functions/Random.html" title="class in org.apache.jmeter.functions">Random</A>, <A HREF="../../../../org/apache/jmeter/functions/RegexFunction.html" title="class in org.apache.jmeter.functions">RegexFunction</A>, <A HREF="../../../.
./org/apache/jmeter/functions/SetProperty.html" title="class in org.apache.jmeter.functions">SetProperty</A>, <A HREF="../../../../org/apache/jmeter/functions/SplitFunction.html" title="class in org.apache.jmeter.functions">SplitFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/StringFromFile.html" title="class in org.apache.jmeter.functions">StringFromFile</A>, <A HREF="../../../../org/apache/jmeter/functions/TimeFunction.html" title="class in org.apache.jmeter.functions">TimeFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/Variable.html" title="class in org.apache.jmeter.functions">Variable</A>, <A HREF="../../../../org/apache/jmeter/functions/XPath.html" title="class in org.apache.jmeter.functions">XPath</A></DD>
+<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/jmeter/functions/BeanShell.html" title="class in org.apache.jmeter.functions">BeanShell</A>, <A HREF="../../../../org/apache/jmeter/functions/CSVRead.html" title="class in org.apache.jmeter.functions">CSVRead</A>, <A HREF="../../../../org/apache/jmeter/functions/EvalFunction.html" title="class in org.apache.jmeter.functions">EvalFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/EvalVarFunction.html" title="class in org.apache.jmeter.functions">EvalVarFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/IntSum.html" title="class in org.apache.jmeter.functions">IntSum</A>, <A HREF="../../../../org/apache/jmeter/functions/IterationCounter.html" title="class in org.apache.jmeter.functions">IterationCounter</A>, <A HREF="../../../../org/apache/jmeter/functions/JavaScript.html" title="class in org.apache.jmeter.functions">JavaScript</A>, <A HREF="../../../../org/apache/jmeter/functions/J
exlFunction.html" title="class in org.apache.jmeter.functions">JexlFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/LogFunction.html" title="class in org.apache.jmeter.functions">LogFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/LogFunction2.html" title="class in org.apache.jmeter.functions">LogFunction2</A>, <A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions">LongSum</A>, <A HREF="../../../../org/apache/jmeter/functions/MachineName.html" title="class in org.apache.jmeter.functions">MachineName</A>, <A HREF="../../../../org/apache/jmeter/functions/Property.html" title="class in org.apache.jmeter.functions">Property</A>, <A HREF="../../../../org/apache/jmeter/functions/Property2.html" title="class in org.apache.jmeter.functions">Property2</A>, <A HREF="../../../../org/apache/jmeter/functions/Random.html" title="class in org.apache.jmeter.functions">Random</A>, <A HREF="../../../../org/apache
/jmeter/functions/RegexFunction.html" title="class in org.apache.jmeter.functions">RegexFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/SetProperty.html" title="class in org.apache.jmeter.functions">SetProperty</A>, <A HREF="../../../../org/apache/jmeter/functions/SplitFunction.html" title="class in org.apache.jmeter.functions">SplitFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/StringFromFile.html" title="class in org.apache.jmeter.functions">StringFromFile</A>, <A HREF="../../../../org/apache/jmeter/functions/ThreadNumber.html" title="class in org.apache.jmeter.functions">ThreadNumber</A>, <A HREF="../../../../org/apache/jmeter/functions/TimeFunction.html" title="class in org.apache.jmeter.functions">TimeFunction</A>, <A HREF="../../../../org/apache/jmeter/functions/Variable.html" title="class in org.apache.jmeter.functions">Variable</A>, <A HREF="../../../../org/apache/jmeter/functions/XPath.html" title="class in org.apache.jmeter.functions"
>XPath</A></DD>
</DL>
<HR>
<DL>
@@ -139,12 +139,30 @@
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters,
+ int minimum)</CODE>
+
+<BR>
+ Utility method to check parameter counts.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters,
+ int count)</CODE>
+
+<BR>
+ Utility method to check parameter counts.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters,
int min,
int max)</CODE>
<BR>
- </TD>
+ Utility method to check parameter counts.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -161,8 +179,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -186,7 +206,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -247,13 +270,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></DL>
@@ -289,11 +309,10 @@
public abstract void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></DL>
@@ -301,7 +320,9 @@
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameters</CODE> -
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -346,13 +367,55 @@
int max)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
+<DD>Utility method to check parameter counts.
+<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
+<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - collection of parameters<DD><CODE>min</CODE> - minimum number of parameters allowed<DD><CODE>max</CODE> - maximum number of parameters allowed
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE> - if the number of parameters is incorrect</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="checkParameterCount(java.util.Collection, int)"><!-- --></A><H3>
+checkParameterCount</H3>
+<PRE>
+protected void <B>checkParameterCount</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters,
+ int count)
+ throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
+<DL>
+<DD>Utility method to check parameter counts.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - collection of parameters<DD><CODE>count</CODE> - number of parameters expected
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE> - if the number of parameters is incorrect</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="checkMinParameterCount(java.util.Collection, int)"><!-- --></A><H3>
+checkMinParameterCount</H3>
+<PRE>
+protected void <B>checkMinParameterCount</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters,
+ int minimum)
+ throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
+<DL>
+<DD>Utility method to check parameter counts.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - collection of parameters<DD><CODE>minimum</CODE> - number of parameters expected
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE> - if the number of parameters is incorrect</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
@@ -414,6 +477,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/BeanShell.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/BeanShell.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/BeanShell.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/BeanShell.html Tue Apr 8 17:39:07 2008
@@ -166,8 +166,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -200,7 +202,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/BeanShell.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -209,7 +214,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -294,13 +299,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -333,11 +336,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -345,7 +348,9 @@
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -377,9 +382,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -451,6 +454,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/CSVRead.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/CSVRead.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/CSVRead.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/CSVRead.html Tue Apr 8 17:39:07 2008
@@ -119,8 +119,6 @@
<P>
<DL>
-<DT><B>Version:</B></DT>
- <DD>$Revision: 539777 $ Last Updated: $Date: 2007-05-19 18:04:39 +0100 (Sat, 19 May 2007) $</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.jmeter.functions.CSVRead">Serialized Form</A></DL>
<HR>
@@ -170,8 +168,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -196,7 +196,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/CSVRead.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -205,7 +208,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -274,13 +277,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -302,9 +303,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -343,11 +342,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -417,6 +416,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalFunction.html Tue Apr 8 17:39:07 2008
@@ -155,8 +155,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -181,7 +183,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/EvalFunction.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -190,7 +195,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -259,13 +264,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -284,11 +287,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -296,7 +299,9 @@
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -328,9 +333,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -402,6 +405,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalVarFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalVarFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalVarFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/EvalVarFunction.html Tue Apr 8 17:39:07 2008
@@ -155,8 +155,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -181,7 +183,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/EvalVarFunction.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -190,7 +195,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -259,13 +264,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -284,11 +287,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -296,7 +299,9 @@
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -328,9 +333,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -402,6 +405,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileRowColContainer.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileRowColContainer.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileRowColContainer.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileRowColContainer.html Tue Apr 8 17:39:07 2008
@@ -376,6 +376,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileWrapper.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileWrapper.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileWrapper.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/FileWrapper.html Tue Apr 8 17:39:07 2008
@@ -313,6 +313,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Function.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Function.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Function.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Function.html Tue Apr 8 17:39:07 2008
@@ -85,19 +85,17 @@
<BR>
Interface Function</H2>
<DL>
-<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A>, <A HREF="../../../../org/apache/jmeter/engine/util/CompoundVariable.html" title="class in org.apache.jmeter.engine.util">CompoundVariable</A>, <A HREF="../../../../org/apache/jmeter/functions/ThreadNumber.html" title="class in org.apache.jmeter.functions">ThreadNumber</A></DD>
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A>, <A HREF="../../../../org/apache/jmeter/engine/util/CompoundVariable.html" title="class in org.apache.jmeter.engine.util">CompoundVariable</A></DD>
</DL>
<HR>
<DL>
<DT>public interface <B>Function</B></DL>
<P>
-<DL>
-<DT><B>Version:</B></DT>
- <DD>$Revision: 493779 $</DD>
-<DT><B>Author:</B></DT>
- <DD>mstover</DD>
-</DL>
+Methods that a function must implement
+<P>
+
+<P>
<HR>
<P>
@@ -236,9 +234,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -307,6 +303,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IntSum.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IntSum.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IntSum.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IntSum.html Tue Apr 8 17:39:07 2008
@@ -102,9 +102,8 @@
<P>
<DL>
-<DT><B>Author:</B></DT>
- <DD><a href="mailto:seade@backstagetech.com.au">Scott Eade</a></DD>
-<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.jmeter.functions.IntSum">Serialized Form</A></DL>
+<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions"><CODE>LongSum</CODE></A>,
+<A HREF="../../../../serialized-form.html#org.apache.jmeter.functions.IntSum">Serialized Form</A></DL>
<HR>
<P>
@@ -186,7 +185,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -381,6 +380,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/InvalidVariableException.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/InvalidVariableException.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/InvalidVariableException.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/InvalidVariableException.html Tue Apr 8 17:39:07 2008
@@ -247,6 +247,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IterationCounter.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IterationCounter.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IterationCounter.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/IterationCounter.html Tue Apr 8 17:39:07 2008
@@ -147,8 +147,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -173,7 +175,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/IterationCounter.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -182,7 +187,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -251,13 +256,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -276,11 +279,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -288,7 +291,9 @@
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -320,9 +325,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -394,6 +397,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
Modified: jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JavaScript.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JavaScript.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JavaScript.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JavaScript.html Tue Apr 8 17:39:07 2008
@@ -147,8 +147,10 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)</CODE>
<BR>
- Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -173,7 +175,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/JavaScript.html#setParameters(java.util.Collection)">setParameters</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)</CODE>
<BR>
- A collection of the parameters used to configure your function. </TD>
+ <b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_org.apache.jmeter.functions.AbstractFunction"><!-- --></A>
@@ -182,7 +187,7 @@
<TD><B>Methods inherited from class org.apache.jmeter.functions.<A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
+<TD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkMinParameterCount(java.util.Collection, int)">checkMinParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#checkParameterCount(java.util.Collection, int, int)">checkParameterCount</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute()">execute</A>, <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#getVariables()">getVariables</A></CODE></TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -251,13 +256,11 @@
<A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> currentSampler)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>Given the previous SampleResult and the current Sampler, return a string
- to use as a replacement value for the function call. Assume
- "setParameter" was previously called.
-
- This method must be threadsafe - multiple threads will be using the same
- object.
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -276,11 +279,11 @@
public void <B>setParameters</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A> parameters)
throws <A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></PRE>
<DL>
-<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE></B></DD>
-<DD>A collection of the parameters used to configure your function. Each
- parameter is a CompoundFunction and can be resolved by calling the
- execute() method of the CompoundFunction (which should be done at
- execution.)
+<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></B></DD>
+<DD><p><b>
+ N.B. setParameters() and execute() are called from different threads,
+ so both must be synchronized unless there are no parameters to save
+ </b></p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)">setParameters</A></CODE> in interface <CODE><A HREF="../../../../org/apache/jmeter/functions/Function.html" title="interface in org.apache.jmeter.functions">Function</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html#setParameters(java.util.Collection)">setParameters</A></CODE> in class <CODE><A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A></CODE></DL>
@@ -288,7 +291,9 @@
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE>Note: This may not be called (e.g. if no parameters are provided)</CODE></A></DL>
+<DD><CODE><A HREF="../../../../org/apache/jmeter/functions/InvalidVariableException.html" title="class in org.apache.jmeter.functions">InvalidVariableException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jmeter/functions/Function.html#setParameters(java.util.Collection)"><CODE><br/>
+ Note: This is always called even if no parameters are provided
+ (versions of JMeter after 2.3.1)</CODE></A></DL>
</DD>
</DL>
<HR>
@@ -320,9 +325,7 @@
<DD>Return a list of strings briefly describing each parameter your function
takes. Please use JMeterUtils.getResString(resource_name) to grab a
resource string. Otherwise, your help text will be difficult to
- internationalize. Add your strings to all
- org.apache.jmeter.resources.*.properties files. Do not worry about
- translating - that's someone else's responsibility.
+ internationalize.
This list is not optional. If you don't wish to write help, you must at
least return a List containing the correct number of blank strings, one
@@ -394,6 +397,6 @@
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 1998-2007 Apache Software Foundation. All Rights Reserved.
+Copyright © 1998-2008 Apache Software Foundation. All Rights Reserved.
</BODY>
</HTML>
---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org