org.eclipse.ptp.ems.core

Interface IEnvManagerConfig

All Known Implementing Classes:

EnvManagerConfigString, EnvManagerProjectProperties

public interface IEnvManagerConfig

A configuration of an environment management system.

The following configuration settings are persisted.

• Enablement. This is true iff custom environment manager settings should be used (i.e., a custom set of environment modules or SoftEnv macros should be used, rather than the defaults).
• A list of configuration elements. These are the names of the modules/SoftEnv macros/etc. that should be loaded (if enabled).
• A connection name. This is the name of the connection for which this configuration was constructed. This is used exclusively for sanity checking: if the stored connection name is different than the actual connection name, then the stored configuration is probably for a different machine, and so the configuration is probably incomplete or invalid for the actual machine.

Since:

6.0

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getConfigElements() Returns the value of a configuration setting containing the list of selected environment configuration elements (modules/SoftEnv macros/etc.).
java.lang.String	getConnectionName() Returns the value of the connection name configuration setting.
java.lang.String	getManualConfigText() Returns the value of a configuration setting containing manually-entered configuration commands.
boolean	isEnvMgmtEnabled() Returns the value of a configuration setting indicating whether environment management support is enabled for this project.
boolean	isManualConfigEnabled() Returns the value of a configuration setting indicating whether manually-entered configuration commands should be used.
void	setConfigElements(java.util.List<java.lang.String> selectedModules) Sets a configuration setting containing the list of selected environment configuration elements (environment modules/SoftEnv macros/etc.).
void	setConnectionName(java.lang.String connectionName) Sets the connection name configuration setting.
void	setEnvMgmtEnabled(boolean enabled) Sets a configuration setting indicating whether environment management support is enabled.
void	setManualConfig(boolean enabled) Sets a configuration setting indicating whether manually-entered configuration commands should be used.
void	setManualConfigText(java.lang.String manualConfigText) Sets a configuration setting containing manually-entered configuration commands.

Method Detail

setEnvMgmtEnabled

void setEnvMgmtEnabled(boolean enabled)

Sets a configuration setting indicating whether environment management support is enabled.

Parameters:

enabled - true to use a custom set of modules; false to use defaults

isEnvMgmtEnabled

boolean isEnvMgmtEnabled()

Returns the value of a configuration setting indicating whether environment management support is enabled for this project.

Returns:

non-null

setManualConfig

void setManualConfig(boolean enabled)

Sets a configuration setting indicating whether manually-entered configuration commands should be used.

Parameters:

enabled - true to use a custom set of modules; false to use defaults

isManualConfigEnabled

boolean isManualConfigEnabled()

Returns the value of a configuration setting indicating whether manually-entered configuration commands should be used.

Returns:

non-null

setManualConfigText

void setManualConfigText(java.lang.String manualConfigText)

Sets a configuration setting containing manually-entered configuration commands.

Note that null is indistinguishable from the empty string: in both cases, getManualConfigText() will return the empty string.

Parameters:

manualConfigText -

getManualConfigText

java.lang.String getManualConfigText()

Returns the value of a configuration setting containing manually-entered configuration commands.

Returns:

non-null

setConfigElements

void setConfigElements(java.util.List<java.lang.String> selectedModules)

Sets a configuration setting containing the list of selected environment configuration elements (environment modules/SoftEnv macros/etc.).

Note that null is indistinguishable from the empty string: in both cases, getConfigElements() will return an empty list.

Parameters:

selectedModules - (may be null)

Since:

2.0

getConfigElements

java.util.List<java.lang.String> getConfigElements()

Returns the value of a configuration setting containing the list of selected environment configuration elements (modules/SoftEnv macros/etc.).

This may return an empty set but will never return null.

Returns:

non-null

Since:

2.0

setConnectionName

void setConnectionName(java.lang.String connectionName)

Sets the connection name configuration setting.

Note that null is indistinguishable from the empty string: in both cases, getConnectionName() will return the empty string.

Parameters:

connectionName - (may be null)

getConnectionName

java.lang.String getConnectionName()

Returns the value of the connection name configuration setting.

This may return the empty string but will never return null.

Returns:

non-null