org.apache.jmeter.functions

Class Property2

java.lang.Object

org.apache.jmeter.functions.AbstractFunction

org.apache.jmeter.functions.Property2

All Implemented Interfaces:

org.apache.jmeter.functions.Function

public class Property2
extends org.apache.jmeter.functions.AbstractFunction

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)

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
Property2()

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(org.apache.jmeter.samplers.SampleResult previousResult, org.apache.jmeter.samplers.Sampler currentSampler)
java.util.List<java.lang.String>	getArgumentDesc()
java.lang.String	getReferenceKey()
void	setParameters(java.util.Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters)

Methods inherited from class org.apache.jmeter.functions.AbstractFunction

addVariableValue, 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

Property2

public Property2()

Method Detail

execute

public java.lang.String execute(org.apache.jmeter.samplers.SampleResult previousResult,
                                org.apache.jmeter.samplers.Sampler currentSampler)
                         throws org.apache.jmeter.functions.InvalidVariableException

Specified by:

execute in interface org.apache.jmeter.functions.Function

Specified by:

execute in class org.apache.jmeter.functions.AbstractFunction

Throws:

org.apache.jmeter.functions.InvalidVariableException

setParameters

public void setParameters(java.util.Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters)
                   throws org.apache.jmeter.functions.InvalidVariableException

Specified by:

setParameters in interface org.apache.jmeter.functions.Function

Specified by:

setParameters in class org.apache.jmeter.functions.AbstractFunction

Throws:

org.apache.jmeter.functions.InvalidVariableException

getReferenceKey

public java.lang.String getReferenceKey()

Specified by:

getReferenceKey in interface org.apache.jmeter.functions.Function

Specified by:

getReferenceKey in class org.apache.jmeter.functions.AbstractFunction

getArgumentDesc

public java.util.List<java.lang.String> getArgumentDesc()