EnvironmentVariablesHandler (adams-pom 24.11.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, OptionHandler

All Known Implementing Classes:

Command, Exec, Exec
```
public interface EnvironmentVariablesHandler
extends OptionHandler
```
Interface for classes that handle environment variables.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`envVarsTipText()`	Returns the tip text for this property.
`BaseKeyValuePair[]`	`getEnvVars()`	Returns the environment variables to overlay on top of the current ones.
`void`	`setEnvVars(BaseKeyValuePair[] value)`	Sets the environment variables to overlay on top of the current ones.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

- Method Detail
  - setEnvVars
```
void setEnvVars(BaseKeyValuePair[] value)
```
    Sets the environment variables to overlay on top of the current ones.
    
    Parameters:
    
    value - the environment variables
  - getEnvVars
```
BaseKeyValuePair[] getEnvVars()
```
    Returns the environment variables to overlay on top of the current ones.
    
    Returns:
    
    the environment variables
  - envVarsTipText
```
String envVarsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.