| org.apache.jmeter.functions.Function
All known Subclasses: org.apache.jmeter.functions.AbstractFunction, org.apache.jmeter.engine.util.CompoundVariable, org.apache.jmeter.functions.ThreadNumber,
| Function | | public interface Function (Code) | |
author:
mstover
version:
$Revision: 493779 $ |
| Method Summary | |
| public String | execute(SampleResult previousResult, Sampler currentSampler)
Given the previous SampleResult and the current Sampler, return a string
to use as a replacement value for the function call. | | public List | getArgumentDesc()
Return a list of strings briefly describing each parameter your function
takes. | | public String | getReferenceKey()
Return the name of your function. | | public void | setParameters(Collection parameters)
A collection of the parameters used to configure your function. |
| execute | | public String execute(SampleResult previousResult, Sampler currentSampler) throws InvalidVariableException(Code) | | 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.
|
| getArgumentDesc | | public List getArgumentDesc()(Code) | | 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.
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
for each argument.
|
| getReferenceKey | | public String getReferenceKey()(Code) | | Return the name of your function. Convention is to prepend "__" to the
name (ie "__regexFunction")
|
| setParameters | | public void setParameters(Collection parameters) throws InvalidVariableException(Code) | | 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.)
Parameters:
parameters -
throws:
InvalidVariableException - |
|
|