ConfigurationPlugin Class Reference

Inheritance diagram for ConfigurationPlugin:

Collaboration diagram for ConfigurationPlugin:

Class Description

---

Abstract class that represents a plug in for class Configuration to provide configuration data from specific configuration data source.

See documentation of namespace cs.aworx.lib.config for more information on ALib external configuration variables.

The plug-in also may have the ability to write data. The default implementation for writing configuration data returns constant false, indicating that this plug-in never writes anything (e.g. command line parameter plug-in, environment variable plug-in).

Category and Variable names are character case insensitive for the plug-ins predefined with ALib. It is recommended to to ignore character case in custom specializations of this class as well.

Note

In the C# version, some method of this class accept parameters of type Object. In this case, the object is converted to a string (if not of string type already).

Public Fields
XTernalizer	StringConverter

Public Methods
abstract bool	Load (Variable variable, bool searchOnly=false)
virtual bool	Store (Variable variable)
virtual bool	Store (Variable variable, Object externalizedValue)

Protected Fields
XTernalizer	defaultStringConverter = new XTernalizer()

Protected Methods
	ConfigurationPlugin ()

Constructor & Destructor Documentation

ConfigurationPlugin()

ConfigurationPlugin ( )

inlineprotected

---

Constructor which is protected, as this is an abstract class.

Member Function Documentation

Load()

abstract bool Load ( Variable  variable, bool  searchOnly = false  )

pure virtual

---

Abstract method that has to be overwritten by descendants. Searches and by default retrieves the value of a configuration variable. If searchOnly is true, then the variable value is not read.

Parameters

variable	The variable to retrieve.
searchOnly	If true, the variable must not be read. Defaults to false.

Returns

true if variable was found within this configuration source, false if not.

Implemented in Environment, CLIArgs, and InMemoryPlugin.

Store() [1/2]

virtual bool Store ( Variable  variable )

inlinevirtual

---

Writes a variable to the configuration. This default implementation just returns false. If this method is not overwritten in descendants, those descendants are not designed to write data.

Parameters

variable

The variable to store.

Returns

true if the variable was written, false if not which typically indicates that this plug-in is not able to write values.

Reimplemented in IniFile, and InMemoryPlugin.

Store() [2/2]

virtual bool Store ( Variable  variable, Object  externalizedValue  )

inlinevirtual

---

Convenience method that parses the values from the given string using field StringConverter and then invokes Store.

Parameters

variable	The variable to store.
externalizedValue	The value to parse into the variable before storing

Returns

true if the variable was written, false if not which typically indicates that this plug-in is not able to write values.

Member Data Documentation

defaultStringConverter

XTernalizer defaultStringConverter = new XTernalizer()

protected

The default external string converter

StringConverter

XTernalizer StringConverter

The external string converter. By default this points to field defaultStringConverter.

---

The documentation for this class was generated from the following file:

• ConfigurationPlugin.cs