Package org.apache.jmeter.functions
Class Property
java.lang.Object
org.apache.jmeter.functions.AbstractFunction
org.apache.jmeter.functions.Property
- All Implemented Interfaces:
org.apache.jmeter.functions.Function
@AutoService(org.apache.jmeter.functions.Function.class)
public class Property
extends org.apache.jmeter.functions.AbstractFunction
Function to get a JMeter property, and optionally store it
Parameters:
- property name
- variable name (optional)
- default value (optional)
Returns:
- the property value, but if not found:
- the default value, but if not defined:
- the property name itself
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute
(org.apache.jmeter.samplers.SampleResult previousResult, org.apache.jmeter.samplers.Sampler currentSampler) void
setParameters
(Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters) Methods inherited from class org.apache.jmeter.functions.AbstractFunction
addVariableValue, checkMinParameterCount, checkParameterCount, checkParameterCount, execute, getVariables
-
Constructor Details
-
Property
public Property()
-
-
Method Details
-
execute
public String execute(org.apache.jmeter.samplers.SampleResult previousResult, org.apache.jmeter.samplers.Sampler currentSampler) throws org.apache.jmeter.functions.InvalidVariableException - Specified by:
execute
in interfaceorg.apache.jmeter.functions.Function
- Specified by:
execute
in classorg.apache.jmeter.functions.AbstractFunction
- Throws:
org.apache.jmeter.functions.InvalidVariableException
-
setParameters
public void setParameters(Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters) throws org.apache.jmeter.functions.InvalidVariableException - Specified by:
setParameters
in interfaceorg.apache.jmeter.functions.Function
- Specified by:
setParameters
in classorg.apache.jmeter.functions.AbstractFunction
- Throws:
org.apache.jmeter.functions.InvalidVariableException
-
getReferenceKey
- Specified by:
getReferenceKey
in interfaceorg.apache.jmeter.functions.Function
- Specified by:
getReferenceKey
in classorg.apache.jmeter.functions.AbstractFunction
-
getArgumentDesc
-