Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.jmeter.config
Class Argument  view Argument download Argument.java

java.lang.Object
  extended byorg.apache.jmeter.testelement.AbstractTestElement
      extended byorg.apache.jmeter.config.Argument
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, org.apache.jmeter.testelement.TestElement

public class Argument
extends org.apache.jmeter.testelement.AbstractTestElement
implements java.io.Serializable

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

Version:
$Revision: 1.10.2.1 $

Field Summary
static java.lang.String ARG_NAME
          Name used to store the argument's name.
private static Logger log
           
static java.lang.String METADATA
          Name used to store the argument's metadata.
static java.lang.String VALUE
          Name used to store the argument's value.
 
Fields inherited from class org.apache.jmeter.testelement.AbstractTestElement
 
Fields inherited from interface org.apache.jmeter.testelement.TestElement
ENABLED, GUI_CLASS, NAME, TEST_CLASS
 
Constructor Summary
Argument()
          Create a new Argument without a name, value, or metadata.
Argument(java.lang.String name, java.lang.String value)
          Create a new Argument with the specified name and value, and no metadata.
Argument(java.lang.String name, java.lang.String value, java.lang.String metadata)
          Create a new Argument with the specified name, value, and metadata.
 
Method Summary
 java.lang.String getMetaData()
          Gets the Meta Data attribute of the Argument.
 java.lang.String getName()
          Get the name of the Argument.
 java.lang.String getValue()
          Gets the value of the Argument object.
 void setMetaData(java.lang.String newMetaData)
          Sets the Meta Data attribute of the Argument.
 void setName(java.lang.String newName)
          Set the name of the Argument.
 void setValue(java.lang.String newValue)
          Sets the value of the Argument.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addProperty, addTestElement, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, nextIsNull, propertyIterator, recoverRunningVersion, removeProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, threadFinished, threadStarted, traverse, traverseCollection, traverseMap, traverseProperty
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

private static Logger log

ARG_NAME

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

See Also:
Constant Field Values

VALUE

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

See Also:
Constant Field Values

METADATA

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

See Also:
Constant Field Values
Constructor Detail

Argument

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


Argument

public Argument(java.lang.String name,
                java.lang.String value)
Create a new Argument with the specified name and value, and no metadata.


Argument

public Argument(java.lang.String name,
                java.lang.String value,
                java.lang.String metadata)
Create a new Argument with the specified name, value, and metadata.

Method Detail

setName

public void setName(java.lang.String newName)
Set the name of the Argument.


getName

public java.lang.String getName()
Get the name of the Argument.


setValue

public void setValue(java.lang.String newValue)
Sets the value of the Argument.


getValue

public java.lang.String getValue()
Gets the value of the Argument object.


setMetaData

public void setMetaData(java.lang.String newMetaData)
Sets the Meta Data attribute of the Argument.


getMetaData

public java.lang.String getMetaData()
Gets the Meta Data attribute of the Argument.


toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).