org.eclipse.higgins.configuration.api
Interface IConfigurationHandler

public interface IConfigurationHandler

Method Summary

void	applyUpdates() Commits any updates made to the settings created by the configure() call.
boolean	configure(Map mapConfigurationSettings) Use properties in mapConfigurationSettings to read/create configuration map.
ISettingDescriptor	getSettingDescriptor() Returns the global setting descriptor created by the configure call.
Map	getSettings() Return settings created by configure call, or null if not yet configured.
void	setConfigurationBase(String str) Set pathname to directory that contains configuration files.
void	setGlobalSettingDescriptor(ISettingDescriptor settingDescriptor) Sets the global setting descriptor.
void	setGlobalSettings(Map settings) Sets the global settings map.

Method Detail

setConfigurationBase

public void setConfigurationBase(String str)

Set pathname to directory that contains configuration files.

configure

public boolean configure(Map mapConfigurationSettings)
                  throws Exception

Use properties in mapConfigurationSettings to read/create configuration map. Should be implemented as .

Returns:

TRUE if configuration is successful, FALSE otherwise.

Throws:

Exception

getSettings

public Map getSettings()
                throws Exception

Return settings created by configure call, or null if not yet configured.

Throws:

Exception

applyUpdates

public void applyUpdates()
                  throws Exception

Commits any updates made to the settings created by the configure() call.

Throws:

Exception

getSettingDescriptor

public ISettingDescriptor getSettingDescriptor()
                                        throws Exception

Returns the global setting descriptor created by the configure call.

Throws:

Exception

setGlobalSettings

public void setGlobalSettings(Map settings)
                       throws Exception

Sets the global settings map. This is typically used when a new handler is created specifically for writing back settings to a new configuration file.

Throws:

Exception

setGlobalSettingDescriptor

public void setGlobalSettingDescriptor(ISettingDescriptor settingDescriptor)
                                throws Exception

Sets the global setting descriptor. Typically used when a new handler is created specifically for writing back settings to a new configuration file.

Parameters:

settingDescriptor -

Throws:

Exception