Package org.apache.jmeter.config
Class Argument
java.lang.Object
org.apache.jmeter.testelement.AbstractTestElement
org.apache.jmeter.config.Argument
- All Implemented Interfaces:
Serializable
,Cloneable
,Searchable
,TestElement
- Direct Known Subclasses:
HTTPArgument
Class representing an argument. Each argument consists of a name/value pair,
as well as (optional) metadata.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Name used to store the argument's name.static final String
Name used to store the argument's description.static final String
Name used to store the argument's metadata.static final String
Name used to store the argument's value.Fields inherited from interface org.apache.jmeter.testelement.TestElement
COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS
-
Constructor Summary
ConstructorsConstructorDescriptionArgument()
Create a new Argument without a name, value, or metadata.Create a new Argument with the specified name and value, and no metadata.Create a new Argument with the specified name, value, and metadata.Create a new Argument with the specified name, value, and metadata. -
Method Summary
Modifier and TypeMethodDescriptionGets the Meta Data attribute of the Argument.Gets the Meta Data attribute of the Argument.getName()
Get the name of the Argument.getValue()
Gets the value of the Argument object.boolean
isSkippable
(String parameterName) Is this parameter skippable, i.e. empty/blank string or it looks like an unrecognised variable.void
setDescription
(String description) Sets the Description attribute of the Argument.void
setMetaData
(String newMetaData) Sets the Meta Data attribute of the Argument.void
Set the name of the Argument.void
Sets the value of the Argument.toString()
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty
-
Field Details
-
ARG_NAME
Name used to store the argument's name.- See Also:
-
VALUE
Name used to store the argument's value.- See Also:
-
DESCRIPTION
Name used to store the argument's description.- See Also:
-
METADATA
Name used to store the argument's metadata.- See Also:
-
-
Constructor Details
-
Argument
public Argument()Create a new Argument without a name, value, or metadata. -
Argument
Create a new Argument with the specified name and value, and no metadata.- Parameters:
name
- the argument namevalue
- the argument value
-
Argument
Create a new Argument with the specified name, value, and metadata.- Parameters:
name
- the argument namevalue
- the argument valuemetadata
- the argument metadata
-
Argument
Create a new Argument with the specified name, value, and metadata.- Parameters:
name
- the argument namevalue
- the argument valuemetadata
- the argument metadatadescription
- the argument description
-
-
Method Details
-
setName
Set the name of the Argument.- Specified by:
setName
in interfaceTestElement
- Overrides:
setName
in classAbstractTestElement
- Parameters:
newName
- the new name
-
getName
Get the name of the Argument.- Specified by:
getName
in interfaceTestElement
- Overrides:
getName
in classAbstractTestElement
- Returns:
- the attribute's name
-
setValue
Sets the value of the Argument.- Parameters:
newValue
- the new value
-
getValue
Gets the value of the Argument object.- Returns:
- the attribute's value
-
setDescription
Sets the Description attribute of the Argument.- Parameters:
description
- the new description
-
getDescription
Gets the Meta Data attribute of the Argument.- Returns:
- the MetaData value
-
setMetaData
Sets the Meta Data attribute of the Argument.- Parameters:
newMetaData
- the new metadata
-
getMetaData
Gets the Meta Data attribute of the Argument.- Returns:
- the MetaData value
-
toString
-
isSkippable
Is this parameter skippable, i.e. empty/blank string or it looks like an unrecognised variable.- Parameters:
parameterName
- - parameter name- Returns:
- true if parameter should be skipped
-