org.eclipse.higgins.configuration.xml
Interface ISettingHandler

All Known Implementing Classes:

BooleanHandler, ClassInstanceHandler, ClassSingletonHandler, DecimalHandler, FileHandler, FloatHandler, IncludeHandler, InstanceHandler, IntegerHandler, ListHandler, MapHandler, ReferenceHandler, SingletonHandler, StringHandler, URIHandler

public interface ISettingHandler

Author:

mikemci

Method Summary

Object

getSetting(String strName, String strConfigurationBase, Map mapSettingHandlers, Map mapSettingsGlobal, Object settingsParent, org.eclipse.higgins.configuration.api.ISettingDescriptor globalDescriptor, org.eclipse.higgins.configuration.api.ISettingDescriptor parentDescriptor, org.apache.axiom.om.OMElement omSetting) Method to convert XML element (omSetting) to an object that will be placed into a configuration map.

Method Detail

getSetting

public Object getSetting(String strName,
                         String strConfigurationBase,
                         Map mapSettingHandlers,
                         Map mapSettingsGlobal,
                         Object settingsParent,
                         org.eclipse.higgins.configuration.api.ISettingDescriptor globalDescriptor,
                         org.eclipse.higgins.configuration.api.ISettingDescriptor parentDescriptor,
                         org.apache.axiom.om.OMElement omSetting)
                  throws Exception

Method to convert XML element (omSetting) to an object that will be placed into a configuration map. The type of the returned object is implicitly determined by the class implementing the ISettingHandler interface.

Parameters:

strName - Name of setting being processed.

strConfigurationBase - Configuration directory (used for file-oriented settings).

mapSettingHandlers - Map that associates types with ISettingHandler classes.

mapSettingsGlobal - Configuration map containing top-level settings that might be needed for this setting. (E.g., a certificate handler might need information about a previously-configured keystore component.)

settingsParent - Configuration map or list (if any) that will contain this setting.

omSetting - XML element that is being converted to Object.

Returns:

Object that will be put into a configuration Map, associated with given name.

Throws:

Exception