MultiProperty 5.6.3 API

All Implemented Interfaces:

java.io.Serializable , java.lang.Cloneable , java.lang.Comparable , java.lang.Iterable , org.apache.jmeter.testelement.property.JMeterProperty
```
public abstract class MultiProperty
extends AbstractProperty implements Iterable<T>
                    
```
For JMeterProperties that hold multiple properties within, provides a simple interface for retrieving a property iterator for the sub values.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public String`	`name`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract PropertyIterator`	`iterator()`	Get the property iterator to iterate through the sub-values of this JMeterProperty.
`abstract void`	`addProperty(JMeterProperty prop)`	Add a property to the collection.
`abstract void`	`clear()`	Clear away all values in the property.
`void`	`setRunningVersion(boolean running)`	Make the property a running version or turn it off as the running version.
`void`	`mergeIn(JMeterProperty prop)`	Take the given property object and merge it's value with the current property object.

Methods inherited from class org.apache.jmeter.testelement.property.AbstractProperty
clone, compareTo, createProperty, equals, getBooleanValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getName, hashCode, isRunningVersion, setName, toString
Methods inherited from class java.lang.Iterable
forEach, spliterator
Methods inherited from class org.apache.jmeter.testelement.property.JMeterProperty
clone, getObjectValue, getStringValue, recoverRunningVersion, setObjectValue
Methods inherited from class java.lang.Comparable
compareTo
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - iterator
```
 abstract PropertyIterator iterator()
```
    Get the property iterator to iterate through the sub-values of this JMeterProperty.
    
    Returns:
    
    an iterator for the sub-values of this property
  - addProperty
```
 abstract void addProperty(JMeterProperty prop)
```
    Add a property to the collection.
    
    Parameters:
    
    prop - the JMeterProperty to add
  - clear
```
 abstract void clear()
```
    Clear away all values in the property.
  - setRunningVersion
```
 void setRunningVersion(boolean running)
```
    Make the property a running version or turn it off as the running version. A property that is made a running version will preserve the current state in such a way that it is retrievable by a future call to 'recoverRunningVersion()'. Additionally, a property that is a running version will resolve all functions prior to returning it's property value. A non-running version property will return functions as their uncompiled string representation.
  - mergeIn
```
 void mergeIn(JMeterProperty prop)
```
    Take the given property object and merge it's value with the current property object. For most property types, this will simply be ignored. But for collection properties and test element properties, more complex behavior is required.