emulib.emustudio

Interface SettingsManager

public interface SettingsManager

Settings manager provides methods for reading/storing plug-in settings. It is implemented by the main module. Plug-ins get it within the initialization process.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO
static String	NO_GUI

Method Summary

Modifier and Type	Method and Description
String	readSetting(long pluginID, String settingName) Read specified setting from configuration file.
boolean	removeSetting(long pluginID, String settingName) Remove specified setting to from a configuration file.
boolean	writeSetting(long pluginID, String settingName, String val) Write specified setting to a configuration file.

Field Detail

NO_GUI

static final String NO_GUI

See Also:

Constant Field Values

AUTO

static final String AUTO

See Also:

Constant Field Values

Method Detail

readSetting

String readSetting(long pluginID,
                   String settingName)

Read specified setting from configuration file. Setting can be arbitrary. It uses configuration file that user chosen after start of the emulator.

Parameters:

pluginID - plug-in ID

settingName - name of wanted setting (without spaces)

Returns:

setting if it exists (as a String), or null if not

writeSetting

boolean writeSetting(long pluginID,
                     String settingName,
                     String val)

Write specified setting to a configuration file. Setting can be arbitrary, except: - nogui - auto It uses configuration file that user has chosen after start of the emulator.

Parameters:

pluginID - plug-in ID

settingName - name of wanted setting (without spaces) to be written

val - value of the setting (has to be String type)

Returns:

true if the setting was successfully written; false otherwise

removeSetting

boolean removeSetting(long pluginID,
                      String settingName)

Remove specified setting to from a configuration file. Be careful, setting can be arbitrary, except: - nogui - auto It uses configuration file that user chosen after start of the emulator.

Parameters:

pluginID - plug-in ID

settingName - name of wanted setting (without spaces) to be removed

Returns:

true if the setting was successfully removed; false otherwise