org.eclipse.higgins.sts.utilities
Class Configuration

java.lang.Object
  org.eclipse.higgins.sts.utilities.Configuration

All Implemented Interfaces:

org.eclipse.higgins.configuration.api.IConfigurationHandler

public class Configuration

extends Object

implements org.eclipse.higgins.configuration.api.IConfigurationHandler

Author:

mikemci

Field Summary

static org.eclipse.higgins.configuration.xml.ConfigurationHandler

handler

Constructor Summary

Configuration()

Method Summary

void	applyUpdates()
boolean	configure(Map mapConfigurationSettings) Use properties in mapConfigurationSettings to read/create configuration map.
org.eclipse.higgins.configuration.api.ISettingDescriptor	getSettingDescriptor()
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	setFileName(String strFile)
void	setGlobalSettingDescriptor(org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor)
void	setGlobalSettings(Map settings)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

handler

public static org.eclipse.higgins.configuration.xml.ConfigurationHandler handler

Constructor Detail

Configuration

public Configuration()

Method Detail

setConfigurationBase

public void setConfigurationBase(String str)

Set pathname to directory that contains configuration files.

Specified by:

setConfigurationBase in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

setFileName

public void setFileName(String strFile)

configure

public boolean configure(Map mapConfigurationSettings)
                  throws Exception

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

Specified by:

configure in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

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.

Specified by:

getSettings in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

getSettingDescriptor

public org.eclipse.higgins.configuration.api.ISettingDescriptor getSettingDescriptor()
                                                                              throws Exception

Specified by:

getSettingDescriptor in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

setGlobalSettingDescriptor

public void setGlobalSettingDescriptor(org.eclipse.higgins.configuration.api.ISettingDescriptor settingDescriptor)
                                throws Exception

Specified by:

setGlobalSettingDescriptor in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

setGlobalSettings

public void setGlobalSettings(Map settings)
                       throws Exception

Specified by:

setGlobalSettings in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception

applyUpdates

public void applyUpdates()
                  throws Exception

Specified by:

applyUpdates in interface org.eclipse.higgins.configuration.api.IConfigurationHandler

Throws:

Exception