WekaHomeEnvironmentModifier (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.option.AbstractSimpleOptionParser
  - - adams.core.management.AbstractEnvironmentModifier
    - - adams.core.management.WekaHomeEnvironmentModifier

All Implemented Interfaces:

GlobalInfoSupporter, LoggingSupporter, EnvironmentModifier, SimpleOptionParser, SizeOfHandler, Serializable
```
public class WekaHomeEnvironmentModifier
extends AbstractEnvironmentModifier
```
Sets a custom WEKA_HOME environment variable inside the project's home directory.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static String ENV_VAR
the WEKA_HOME environment variable.
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

WekaHomeEnvironmentModifier()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`globalInfo()`	Returns a string describing the object.
`boolean`	`updateEnvironment(List<String> env)`	Updates the environment variables that the `Launcher` uses for launching the ADAMS process.

Methods inherited from class adams.core.option.AbstractSimpleOptionParser
forCommandline, getParser, setOptions, setOptions

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface adams.core.option.SimpleOptionParser
getParser, setOptions

- Field Detail
  - ENV_VAR
```
public static final String ENV_VAR
```
    the WEKA_HOME environment variable.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WekaHomeEnvironmentModifier
```
public WekaHomeEnvironmentModifier()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Returns:
    
    a description suitable for displaying in the gui
  - updateEnvironment
```
public boolean updateEnvironment(List<String> env)
```
    Updates the environment variables that the Launcher uses for launching the ADAMS process.
    
    Parameters:
    
    env - the current key=value pairs
    
    Returns:
    
    if the environment got updated