|
Apache JMeter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jmeter.functions.AbstractFunction
org.apache.jmeter.functions.Property2
public class Property2
Function to get a JMeter property, or a default. Does not offer the option to store the value, as it is just as easy to refetch it. This is a specialisation of the __property() function to make it simpler to use for ThreadGroup GUI etc. The name is also shorter. Parameters: - property name - default value (optional; defaults to "1") Usage: Define the property in jmeter.properties, or on the command-line: java ... -Jpropname=value Retrieve the value in the appropriate GUI by using the string: ${__P(propname)} $(__P(propname,default)} Returns: - the property value, but if not found - the default value, but if not present - "1" (suitable for use in ThreadGroup GUI)
Constructor Summary | |
---|---|
Property2()
|
Method Summary | |
---|---|
String |
execute(SampleResult previousResult,
Sampler currentSampler)
N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files). |
List<String> |
getArgumentDesc()
Return a list of strings briefly describing each parameter your function takes. |
String |
getReferenceKey()
Return the name of your function. |
void |
setParameters(Collection<CompoundVariable> parameters)
Note: This is always called even if no parameters are provided (versions of JMeter after 2.3.1) |
Methods inherited from class org.apache.jmeter.functions.AbstractFunction |
---|
checkMinParameterCount, checkParameterCount, checkParameterCount, execute, getVariables |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Property2()
Method Detail |
---|
public String execute(SampleResult previousResult, Sampler currentSampler) throws InvalidVariableException
N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files).
JMeter ensures setParameters() happens-before execute(): setParameters is executed in main thread, and worker threads are started after that.
execute
in interface Function
execute
in class AbstractFunction
previousResult
- The previous SampleResult
currentSampler
- The current Sampler
InvalidVariableException
- - when the variables for the function call can't be evaluatedFunction.execute(SampleResult, Sampler)
public void setParameters(Collection<CompoundVariable> parameters) throws InvalidVariableException
setParameters
in interface Function
setParameters
in class AbstractFunction
parameters
- The parameters for the function call
InvalidVariableException
- - when the variables for the function call can't be evaluatedFunction.setParameters(Collection)
public String getReferenceKey()
getReferenceKey
in interface Function
getReferenceKey
in class AbstractFunction
Function.getReferenceKey()
public List<String> getArgumentDesc()
|
Apache JMeter | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |