Changeset 3036 for trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable

Timestamp:

03/15/10 14:45:46 (15 years ago)

Author:

epitzer

Message:

make most serializers internal and complete API documentation (#548)

Location:

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable

Files:

• StorableHookAttribute.cs (modified) (1 diff)
• StorableSerializer.cs (modified) (6 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableHookAttribute.cs

@@ -11 +11 @@
   /// Indicates the time at which the hook should be invoked.
   /// </summary>
-  public enum HookType { BeforeSerialization, AfterDeserialization };
+  public enum HookType {
+
+    /// <summary>
+    /// States that this hook should be called before the storable
+    /// serializer starts decomposing the object.
+    /// </summary>
+    BeforeSerialization,
+    
+    /// <summary>
+    /// States that this hook should be called after the storable
+    /// serializer hast complete re-assembled the object.
+    /// </summary>
+    AfterDeserialization };
 
 

trunk/sources/HeuristicLab.Persistence/3.3/Default/CompositeSerializers/Storable/StorableSerializer.cs

@@ -18 +18 @@
   /// </summary>
   [StorableClass]
-  public class StorableSerializer : ICompositeSerializer {
+  public sealed class StorableSerializer : ICompositeSerializer {
 
     #region ICompositeSerializer implementation
 
+    /// <summary>
+    /// Priority 200, one of the first default composite serializers to try.
+    /// </summary>
+    /// <value></value>
     public int Priority {
       get { return 200; }
     }
 
+    /// <summary>
+    /// Determines for every type whether the composite serializer is applicable.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <returns>
+    ///   <c>true</c> if this instance can serialize the specified type; otherwise, <c>false</c>.
+    /// </returns>
     public bool CanSerialize(Type type) {
       if (!ReflectionTools.HasDefaultConstructor(type) &&
@@ -33 +44 @@
     }
 
+    /// <summary>
+    /// Give a reason if possibly why the given type cannot be serialized by this
+    /// ICompositeSerializer.
+    /// </summary>
+    /// <param name="type">The type.</param>
+    /// <returns>
+    /// A string justifying why type cannot be serialized.
+    /// </returns>
     public string JustifyRejection(Type type) {
       if (!ReflectionTools.HasDefaultConstructor(type) &&
@@ -42 +61 @@
     }
 
+    /// <summary>
+    /// Creates the meta info.
+    /// </summary>
+    /// <param name="o">The object.</param>
+    /// <returns>A list of storable components.</returns>
     public IEnumerable<Tag> CreateMetaInfo(object o) {
       InvokeHook(HookType.BeforeSerialization, o);
@@ -47 +71 @@
     }
 
+    /// <summary>
+    /// Decompose an object into <see cref="Tag"/>s, the tag name can be null,
+    /// the order in which elements are generated is guaranteed to be
+    /// the same as they will be supplied to the Populate method.
+    /// </summary>
+    /// <param name="obj">An object.</param>
+    /// <returns>An enumerable of <see cref="Tag"/>s.</returns>
     public IEnumerable<Tag> Decompose(object obj) {
       foreach (var accessor in GetStorableAccessors(obj)) {
@@ -55 +86 @@
     private static readonly object[] defaultArgs = new object[] { true };
 
+    /// <summary>
+    /// Create an instance of the object using the provided meta information.
+    /// </summary>
+    /// <param name="type">A type.</param>
+    /// <param name="metaInfo">The meta information.</param>
+    /// <returns>A fresh instance of the provided type.</returns>
     public object CreateInstance(Type type, IEnumerable<Tag> metaInfo) {
       try {
@@ -66 +103 @@
     }
 
+    /// <summary>
+    /// Populates the specified instance.
+    /// </summary>
+    /// <param name="instance">The instance.</param>
+    /// <param name="objects">The objects.</param>
+    /// <param name="type">The type.</param>
     public void Populate(object instance, IEnumerable<Tag> objects, Type type) {
       var memberDict = new Dictionary<string, Tag>();