org.apache.jmeter.config

Class Argument

Implemented Interfaces:
Cloneable, Serializable, TestElement
Known Direct Subclasses:
HTTPArgument

public class Argument
extends AbstractTestElement
implements Serializable

Class representing an argument. Each argument consists of a name/value pair, as well as (optional) metadata.

Field Summary

static String
ARG_NAME
Name used to store the argument's name.
static String
METADATA
Name used to store the argument's metadata.
static String
VALUE
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

Argument()
Create a new Argument without a name, value, or metadata.
Argument(String name, String value)
Create a new Argument with the specified name and value, and no metadata.
Argument(String name, String value, String metadata)
Create a new Argument with the specified name, value, and metadata.

Method Summary

String
getMetaData()
Gets the Meta Data attribute of the Argument.
String
getName()
Get the name of the Argument.
String
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
setMetaData(String newMetaData)
Sets the Meta Data attribute of the Argument.
void
setName(String newName)
Set the name of the Argument.
void
setValue(String newValue)
Sets the value of the Argument.
String
toString()

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty

Field Details

ARG_NAME

public static final String ARG_NAME
Name used to store the argument's name.

METADATA

public static final String METADATA
Name used to store the argument's metadata.

VALUE

public static final String VALUE
Name used to store the argument's value.

Constructor Details

Argument

public Argument()
Create a new Argument without a name, value, or metadata.

Argument

public Argument(String name,
                String value)
Create a new Argument with the specified name and value, and no metadata.
Parameters:
name - the argument name
value - the argument value

Argument

public Argument(String name,
                String value,
                String metadata)
Create a new Argument with the specified name, value, and metadata.
Parameters:
name - the argument name
value - the argument value
metadata - the argument metadata

Method Details

getMetaData

public String getMetaData()
Gets the Meta Data attribute of the Argument.
Returns:
the MetaData value

getName

public String getName()
Get the name of the Argument.
Specified by:
getName in interface TestElement
Overrides:
getName in interface AbstractTestElement
Returns:
the attribute's name

getValue

public String getValue()
Gets the value of the Argument object.
Returns:
the attribute's value

isSkippable

public boolean isSkippable(String parameterName)
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

setMetaData

public void setMetaData(String newMetaData)
Sets the Meta Data attribute of the Argument.
Parameters:
newMetaData - the new metadata

setName

public void setName(String newName)
Set the name of the Argument.
Specified by:
setName in interface TestElement
Overrides:
setName in interface AbstractTestElement
Parameters:
newName - the new name

setValue

public void setValue(String newValue)
Sets the value of the Argument.
Parameters:
newValue - the new value

toString

public String toString()

Copyright © 1998-2010 Apache Software Foundation. All Rights Reserved.