Package org.apache.jmeter.visualizers.backend

# Class BackendListenerContext

java.lang.Object
org.apache.jmeter.visualizers.backend.BackendListenerContext

public class BackendListenerContext extends Object
BackendListenerContext is used to provide context information to a BackendListenerClient implementation. This currently consists of the initialization parameters which were specified in the GUI.

All of the methods in this class are currently read-only. If update methods are included in the future, they should be defined so that a single instance of `BackendListenerContext` can be associated with each thread. Therefore, no synchronization should be needed. The same instance should be used for all calls to setupTest, runTest, and teardownTest.

Since:
  2.13

## Constructor Summary

Constructors
Constructor
Description
`BackendListenerContext(Map<String,String> params)`
`BackendListenerContext(Arguments args)`

## Method Summary

Modifier and Type
Method
Description
`boolean`
`containsParameter(String name)`
Determine whether or not a value has been specified for the parameter with this name.
`boolean`
`getBooleanParameter(String name, boolean defaultValue)`
`int`
`getIntParameter(String name)`
Get the value of a specified parameter as an integer.
`int`
`getIntParameter(String name, int defaultValue)`
Get the value of a specified parameter as an integer, or return the specified default value if the value was not specified or is not an integer.
`long`
`getLongParameter(String name)`
Get the value of a specified parameter as a long.
`long`
`getLongParameter(String name, long defaultValue)`
Get the value of a specified parameter as along, or return the specified default value if the value was not specified or is not a long.
`String`
`getParameter(String name)`
Get the value of a specific parameter as a String, or null if the value was not specified.
`String`
`getParameter(String name, String defaultValue)`
Get the value of a specified parameter as a String, or return the specified default value if the value was not specified.
`Iterator<String>`
`getParameterNamesIterator()`
Get an iterator of the parameter names.

### Methods inherited from class java.lang.Object

`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Constructor Details

### BackendListenerContext

public BackendListenerContext(Arguments args)

Parameters:
  `args` - the initialization parameters.

### BackendListenerContext

public BackendListenerContext(Map<String,String> params)

Parameters:
  `params` - the initialization parameters.

## Method Details

### containsParameter

public boolean containsParameter(String name)
Determine whether or not a value has been specified for the parameter with this name.

Parameters:
  `name` - the name of the parameter to test
Returns:
  true if the parameter value has been specified, false otherwise.

### getParameterNamesIterator

public Iterator<String> getParameterNamesIterator()
Get an iterator of the parameter names.

Returns:
  an Iterator of Strings of the names of the parameters which have been specified for this test.

### getParameter

public String getParameter(String name)
Get the value of a specific parameter as a String, or null if the value was not specified.

Parameters:
  `name` - the name of the parameter whose value should be retrieved
Returns:
  the value of the parameter, or null if the value was not specified

### getParameter

public String getParameter(String name, String defaultValue)
Get the value of a specified parameter as a String, or return the specified default value if the value was not specified.

Parameters:
  `name` - the name of the parameter whose value should be retrieved
  `defaultValue` - the default value to return if the value of this parameter was not specified
Returns:
  the value of the parameter, or the default value if the parameter was not specified

### getIntParameter

public int getIntParameter(String name)
Get the value of a specified parameter as an integer. An exception will be thrown if the parameter is not specified or if it is not an integer.

Parameters:
  `name` - the name of the parameter whose value should be retrieved
Returns:
  the value of the parameter
Throws:
  `IllegalArgumentException` - if no value defined
  `NumberFormatException` - if the parameter is not specified or is not an integer
See Also:
  - `Integer.parseInt(String)`

### getIntParameter

public int getIntParameter(String name, int defaultValue)
Get the value of a specified parameter as an integer, or return the specified default value if the value was not specified or is not an integer. A warning will be logged if the value is not an integer.

Parameters:
  `name` - the name of the parameter whose value should be retrieved
  `defaultValue` - the default value to return if the value of this parameter was not specified
Returns:
  the value of the parameter, or the default value if the parameter was not specified
See Also:
  - `Integer.parseInt(String)`

### getLongParameter

public long getLongParameter(String name)
Get the value of a specified parameter as a long. An exception will be thrown if the parameter is not specified or if it is not a long.

Parameters:
  `name` - the name of the parameter whose value should be retrieved
Returns:
  the value of the parameter
Throws:
  `NumberFormatException` - if the parameter is not specified or is not a long
See Also:
  - `Long.parseLong(String)`

### getLongParameter

public long getLongParameter(String name, long defaultValue)
Get the value of a specified parameter as along, or return the specified default value if the value was not specified or is not a long. A warning will be logged if the value is not a long. The value may be specified in decimal, hexadecimal, or octal, as defined by Long.decode().

Parameters:
  `name` - the name of the parameter whose value should be retrieved
  `defaultValue` - the default value to return if the value of this parameter was not specified
Returns:
  the value of the parameter, or the default value if the parameter was not specified
See Also:
  - `Long.decode(String)`

### getBooleanParameter

public boolean getBooleanParameter(String name, boolean defaultValue)

Parameters:
  `name` - Parameter name
  `defaultValue` - Default value used if name is not in params
Returns:
  boolean the value of the parameter in the map, or the default value