Changes between Version 2 and Version 3 of PLUGIN_SUPPORT_LIB_CONFIGURING_R1

Timestamp:

06/04/09 17:31:40 (16 years ago)

Author:

mitex

Comment:

--

PLUGIN_SUPPORT_LIB_CONFIGURING_R1

@@ -63 +63 @@
 
 = Design =
- * Package {{{org.sophie2.base.config}}}
+ * Package {{{org.sophie2.base.config}}}.
 
- * Immutable generic class {{{ConfigKey}}} that encapsulates all of the information about a key:
-  * key name - String
+ * Immutable generic class {{{ConfigKey<T>}}} that encapsulates all of the information about a key:
+  * name (of the key) - String
   * configuration file - File
-  * default value (if the key is not present in the file) - Object
+  * default value (if the key is not present in the file) - T
   * schema (for the persistence) - String, for example "imm:int|storage|decimal"
 
- * Class {{{Configuration}}} 
+ * Class {{{ConfigEntry}}} that extends {{{ListEntry}}}
+  * This class represents a key-value pair in a configuration file.
+  * Override {{{getKey}}} to return a {{{ConfigKey}}}.
+
+ * Class {{{Configuration}}} - represents a single configuration file.
+  * configuration file - File
+  * list of {{{ConfigEntry}}}s that stores all key-value pairs in that file.
+  * get......... returns the default value........
+
+ * Class {{{ConfigurationPersister}}} that loads/saves configuration files.
+  * ..........
+  * Register the persister as an extension.
+
+ * Singleton class {{{ConfigurationManager}}}.
+  * {{{T get(ConfigKey<T> key)}}}
+   * Given the file name in the key, finds the corresponding Configuration and then returns the value for that key.
+  * {{{set(ConfigKey<T> key, T value)}}}
+   * Given the file name in the key, finds the corresponding Configuration.
+   * Sets the new value for that key.
+   * Saves the configuration using the persister.
+  * Map<String, Configuration>, which maps Configuration objects to configuration file names.
 
 = Implementation =