Changeset 3004 for trunk/sources/HeuristicLab.Persistence/3.3/Core/ConfigurationService.cs

Timestamp:

03/11/10 12:54:14 (14 years ago)

Author:

epitzer

Message:

add complete persistence API docs (#548)

File:

• trunk/sources/HeuristicLab.Persistence/3.3/Core/ConfigurationService.cs (modified) (6 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Core/ConfigurationService.cs

@@ -13 +13 @@
 namespace HeuristicLab.Persistence.Core {
 
+  /// <summary>
+  /// Provides a persistable configuration of primitive and composite serializers for
+  /// all registered serial formats. Custom formats can be defined and will be saved
+  /// for future sessions. A default configuration can be generated through reflection.
+  /// 
+  /// This class has only a single instance.
+  /// </summary>
   public class ConfigurationService {
 
     private static ConfigurationService instance;
     private readonly Dictionary<IFormat, Configuration> customConfigurations;
+
+    /// <summary>
+    /// List of all available primitive serializers.
+    /// </summary>
     public Dictionary<Type, List<IPrimitiveSerializer>> PrimitiveSerializers { get; private set; }
+
+    /// <summary>
+    /// List of all available composite serializers (discovered through reflection).
+    /// </summary>
     public List<ICompositeSerializer> CompositeSerializers { get; private set; }
+
+    /// <summary>
+    /// List of all available formats (discovered through reflection).    
+    /// </summary>
     public List<IFormat> Formats { get; private set; }
 
@@ -92 +111 @@
     }
 
+
+    /// <summary>
+    /// Rediscover available serializers and discard all custom configurations.
+    /// </summary>
     public void Reset() {
       customConfigurations.Clear();
@@ -108 +131 @@
     }
 
-    class PriortiySorter : IComparer<ICompositeSerializer> {
+    private class PriortiySorter : IComparer<ICompositeSerializer> {
       public int Compare(ICompositeSerializer x, ICompositeSerializer y) {
         return y.Priority - x.Priority;
@@ -169 +192 @@
     }
 
+    /// <summary>
+    /// Get the default (automatically discovered) configuration for a certain format.
+    /// </summary>    
     public Configuration GetDefaultConfig(IFormat format) {
       Dictionary<Type, IPrimitiveSerializer> primitiveConfig = new Dictionary<Type, IPrimitiveSerializer>();
@@ -188 +214 @@
     }
 
+
+    /// <summary>
+    /// Get a configuration for a certain format. This returns a custom configuration
+    /// if defined, otherwise returns the default (automatically discovered) configuration.
+    /// </summary>    
     public Configuration GetConfiguration(IFormat format) {
       if (customConfigurations.ContainsKey(format))
@@ -194 +225 @@
     }
 
+    /// <summary>
+    /// Define a new custom configuration for a ceratin format.
+    /// </summary>    
     public void DefineConfiguration(Configuration configuration) {
       customConfigurations[configuration.Format] = configuration;