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, org.apache.jmeter.testelement.TestElement
Direct Known 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.
See Also:

  • Field Details

  • 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

    • Argument

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

  • Method Details

    • getSchema

      public org.apache.jmeter.config.ArgumentSchema getSchema()
      Specified by:
      getSchema in interface org.apache.jmeter.testelement.TestElement

    • getProps

      public org.apache.jmeter.testelement.schema.PropertiesAccessor<? extends Argument,? extends org.apache.jmeter.config.ArgumentSchema> getProps()
      Specified by:
      getProps in interface org.apache.jmeter.testelement.TestElement

    • setName

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

    • getName

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

    • setValue

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

    • getValue

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

    • setDescription

      public void setDescription(String description)
      Sets the Description attribute of the Argument.
      Parameters:
      description - the new description

    • getDescription

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

    • setMetaData

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

    • getMetaData

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • 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