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 [14/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/functions/JexlFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JexlFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JexlFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/JexlFunction.html Tue Apr 8 17:39:07 2008
@@ -139,12 +139,14 @@
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/JexlFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></B>(<A HREF="../../../../org/apache/jmeter/samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</A> result,
- <A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> sampler)</CODE>
+<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/JexlFunction.html#execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)">execute</A></B>(<A HREF="../../../../org/apache/jmeter/samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</A> previousResult,
+ <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">
@@ -169,7 +171,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/JexlFunction.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>
@@ -178,7 +183,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>
@@ -226,17 +231,15 @@
<A NAME="execute(org.apache.jmeter.samplers.SampleResult, org.apache.jmeter.samplers.Sampler)"><!-- --></A><H3>
execute</H3>
<PRE>
-public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>execute</B>(<A HREF="../../../../org/apache/jmeter/samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</A> result,
- <A HREF="../../../../org/apache/jmeter/samplers/Sampler.html" title="interface in org.apache.jmeter.samplers">Sampler</A> sampler)
+public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>execute</B>(<A HREF="../../../../org/apache/jmeter/samplers/SampleResult.html" title="class in org.apache.jmeter.samplers">SampleResult</A> previousResult,
+ <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>
@@ -258,9 +261,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
@@ -299,11 +300,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>
@@ -311,7 +312,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>
<!-- ========= END OF CLASS DATA ========= -->
@@ -373,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/LogFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction.html Tue Apr 8 17:39:07 2008
@@ -97,11 +97,19 @@
<DT>public class <B>LogFunction</B><DT>extends <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL>
<P>
-Function to log a message
-
- Parameters: - string - log level (optional; defaults to INFO; or DEBUG if
- unrecognised) - throwable message (optional)
+<p>
+ Function to log a message.
+ </p>
+ <p>
+ Parameters:
+ <ul>
+ <li>string value</li>
+ <li>log level (optional; defaults to INFO; or DEBUG if unrecognised; or can use OUT or ERR)</li>
+ <li>throwable message (optional)</li>
+ <li>comment (optional)</li>
+ </ul>
+ </p>
Returns: - the input string
<P>
@@ -156,8 +164,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">
@@ -182,7 +192,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/LogFunction.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>
@@ -191,7 +204,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>
@@ -260,13 +273,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>
@@ -285,11 +296,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>
@@ -297,7 +308,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>
@@ -329,9 +342,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
@@ -403,6 +414,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/LogFunction2.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction2.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction2.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/LogFunction2.html Tue Apr 8 17:39:07 2008
@@ -50,7 +50,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/apache/jmeter/functions/LogFunction.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/jmeter/functions/MachineName.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="LogFunction2.html" target="_top"><B>NO FRAMES</B></A>
@@ -97,13 +97,19 @@
<DT>public class <B>LogFunction2</B><DT>extends <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL>
<P>
-Function to log a message
+<p>
+ Function to log a message.
+ </p>
- Parameters: - string - log level (optional; defaults to INFO; or DEBUG if
- unrecognised) - throwable message (optional)
-
- Returns: - Empty String (so can be used where return value would be a
- nuisance)
+ <p>
+ Parameters:
+ <ul>
+ <li>string value</li>
+ <li>log level (optional; defaults to INFO; or DEBUG if unrecognised; or can use OUT or ERR)</li>
+ <li>throwable message (optional)</li>
+ </ul>
+ </p>
+ Returns: - Empty String (so can be used where return value would be a nuisance)
<P>
<P>
@@ -157,8 +163,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">
@@ -183,7 +191,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/LogFunction2.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>
@@ -192,7 +203,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>
@@ -261,13 +272,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>
@@ -286,11 +295,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>
@@ -298,7 +307,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>
@@ -330,9 +341,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
@@ -376,7 +385,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/apache/jmeter/functions/LogFunction.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/apache/jmeter/functions/MachineName.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
<A HREF="LogFunction2.html" target="_top"><B>NO FRAMES</B></A>
@@ -404,6 +413,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/MachineName.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/MachineName.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/MachineName.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/MachineName.html Tue Apr 8 17:39:07 2008
@@ -49,7 +49,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/jmeter/functions/LogFunction2.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/jmeter/functions/Property.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
@@ -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/MachineName.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
@@ -365,7 +368,7 @@
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/jmeter/functions/LogFunction2.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/jmeter/functions/LongSum.html" title="class in org.apache.jmeter.functions"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/jmeter/functions/Property.html" title="class in org.apache.jmeter.functions"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>
@@ -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/Property.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property.html Tue Apr 8 17:39:07 2008
@@ -161,8 +161,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">
@@ -187,7 +189,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/Property.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>
@@ -196,7 +201,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>
@@ -265,13 +270,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>
@@ -290,11 +293,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>
@@ -302,7 +305,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>
@@ -334,9 +339,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
@@ -408,6 +411,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/Property2.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property2.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property2.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Property2.html Tue Apr 8 17:39:07 2008
@@ -167,8 +167,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">
@@ -193,7 +195,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/Property2.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>
@@ -202,7 +207,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>
@@ -271,13 +276,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>
@@ -296,11 +299,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>
@@ -308,7 +311,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>
@@ -340,9 +345,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
@@ -414,6 +417,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/Random.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Random.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Random.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/Random.html Tue Apr 8 17:39:07 2008
@@ -103,8 +103,6 @@
<P>
<DL>
-<DT><B>Author:</B></DT>
- <DD><a href="mailto:sjkwadzo@praize.com">Jonathan Kwadzo</a></DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.jmeter.functions.Random">Serialized Form</A></DL>
<HR>
@@ -187,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>
@@ -379,6 +377,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/RegexFunction.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/RegexFunction.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/RegexFunction.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/RegexFunction.html Tue Apr 8 17:39:07 2008
@@ -97,6 +97,10 @@
<DT>public class <B>RegexFunction</B><DT>extends <A HREF="../../../../org/apache/jmeter/functions/AbstractFunction.html" title="class in org.apache.jmeter.functions">AbstractFunction</A><DT>implements <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL>
<P>
+Implements regular expression parsing of sample results and variables
+<P>
+
+<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.jmeter.functions.RegexFunction">Serialized Form</A></DL>
<HR>
@@ -170,8 +174,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 +202,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/RegexFunction.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 +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>
@@ -293,13 +302,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>
@@ -321,9 +328,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
@@ -362,11 +367,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>
@@ -374,7 +379,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>
<!-- ========= END OF CLASS DATA ========= -->
@@ -436,6 +443,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/SetProperty.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/SetProperty.html?rev=646154&r1=646153&r2=646154&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/SetProperty.html (original)
+++ jakarta/jmeter/trunk/docs/api/org/apache/jmeter/functions/SetProperty.html Tue Apr 8 17:39:07 2008
@@ -160,8 +160,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 +188,10 @@
<TD><CODE><B><A HREF="../../../../org/apache/jmeter/functions/SetProperty.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>
@@ -195,7 +200,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>
@@ -264,13 +269,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>
@@ -289,11 +292,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>
@@ -301,7 +304,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>
@@ -333,9 +338,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
@@ -407,6 +410,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