Package org.apache.jmeter.config
Class Arguments
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.config.ConfigTestElement
org.apache.jmeter.config.Arguments
- All Implemented Interfaces:
Serializable,Cloneable,Iterable<JMeterProperty>,ConfigElement,Searchable,org.apache.jmeter.testelement.TestElement
A set of Argument objects.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jmeter.testelement.TestElement
org.apache.jmeter.testelement.TestElement.Companion -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name of the property used to store the arguments.Fields inherited from class org.apache.jmeter.config.ConfigTestElement
PASSWORD, USERNAMEFields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, Companion, ENABLED, GUI_CLASS, NAME, TEST_CLASS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddArgument(String name, String value) Add a new argument with the given name and value.voidaddArgument(String name, String value, String metadata) Add a new argument with the given name, value, and metadata.voidaddArgument(String name, String value, String metadata, String description) Add a new argument with the given name, value, metadata and descriptionvoidaddArgument(Argument arg) Add a new argument.voidAdd a new empty argument to the list.voidclear()Clear the arguments.getArgument(int row) Get a single argument.intGet the number of arguments in the list.Get the arguments.Get the arguments as a Map.org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends Arguments,? extends org.apache.jmeter.config.ArgumentsSchema> getProps()org.apache.jmeter.config.ArgumentsSchemaiterator()Get a PropertyIterator of the arguments.voidRemove all arguments from the list.voidremoveArgument(int row) Remove the specified argument from the list.voidremoveArgument(String argName) Remove the argument with the specified name.voidremoveArgument(String argName, String argValue) Remove the argument with the specified name and value.voidremoveArgument(Argument arg) Remove the specified argument from the list.voidsetArguments(List<Argument> arguments) Set the list of arguments.toString()Create a string representation of the arguments.Methods inherited from class org.apache.jmeter.config.ConfigTestElement
addConfigElement, addTestElement, expectsModificationMethods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, canRemove, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traversePropertyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.jmeter.config.ConfigElement
cloneMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getPropertyOrNull, getString, removed, removeProperty, set, set, set, set, set, set, set, set, set
-
Field Details
-
ARGUMENTS
The name of the property used to store the arguments.- See Also:
-
-
Constructor Details
-
Arguments
public Arguments()Create a new Arguments object with no arguments.
-
-
Method Details
-
getSchema
public org.apache.jmeter.config.ArgumentsSchema getSchema()- Specified by:
getSchemain interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
getSchemain classConfigTestElement
-
getProps
public org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends Arguments,? extends org.apache.jmeter.config.ArgumentsSchema> getProps()- Specified by:
getPropsin interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
getPropsin classConfigTestElement
-
getArguments
Get the arguments.- Returns:
- the arguments
-
clear
public void clear()Clear the arguments.- Specified by:
clearin interfaceorg.apache.jmeter.testelement.TestElement- Overrides:
clearin classAbstractTestElement
-
setArguments
Set the list of arguments. Any existing arguments will be lost.- Parameters:
arguments- the new arguments
-
getArgumentsAsMap
Get the arguments as a Map. Each argument name is used as the key, and its value as the value.- Returns:
- a new Map with String keys and values containing the arguments
-
addArgument
Add a new argument with the given name and value.- Parameters:
name- the name of the argumentvalue- the value of the argument
-
addArgument
Add a new argument.- Parameters:
arg- the new argument
-
addArgument
Add a new argument with the given name, value, and metadata.- Parameters:
name- the name of the argumentvalue- the value of the argumentmetadata- the metadata for the argument
-
addArgument
Add a new argument with the given name, value, metadata and description- Parameters:
name- the name of the argumentvalue- the value of the argumentmetadata- the metadata for the argumentdescription- the argument description
-
iterator
Get a PropertyIterator of the arguments.- Specified by:
iteratorin interfaceIterable<JMeterProperty>- Returns:
- an iteration of the arguments
-
toString
Create a string representation of the arguments. -
removeArgument
public void removeArgument(int row) Remove the specified argument from the list.- Parameters:
row- the index of the argument to remove
-
removeArgument
Remove the specified argument from the list.- Parameters:
arg- the argument to remove
-
removeArgument
Remove the argument with the specified name.- Parameters:
argName- the name of the argument to remove
-
removeArgument
Remove the argument with the specified name and value.- Parameters:
argName- the name of the argument to removeargValue- the value to compare - must not be null
-
removeAllArguments
public void removeAllArguments()Remove all arguments from the list. -
addEmptyArgument
public void addEmptyArgument()Add a new empty argument to the list. The new argument will have the empty string as its name and value, and null metadata. -
getArgumentCount
public int getArgumentCount()Get the number of arguments in the list.- Returns:
- the number of arguments
-
getArgument
Get a single argument.- Parameters:
row- the index of the argument to return.- Returns:
- the argument at the specified index, or null if no argument exists at that index.
-