Changeset 3036 for trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive

Timestamp:

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

Author:

epitzer

Message:

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

Location:

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive

Files:

• Bool2XmlSerializer.cs (modified) (1 diff)
• Byte2XmlSerializer.cs (modified) (1 diff)
• Char2XmlFormatter.cs (modified) (1 diff)
• DateTime2XmlSerializer.cs (modified) (1 diff)
• Decimal2XmlSerializer.cs (modified) (1 diff)
• Double2XmlSerializer.cs (modified) (1 diff)
• Float2XmlSerializer.cs (modified) (1 diff)
• Guid2XmlSerializer.cs (modified) (1 diff)
• Int2XmlSerializer.cs (modified) (1 diff)
• Long2XmlSerializer.cs (modified) (1 diff)
• PrimitiveXmlSerializerBase.cs (modified) (1 diff)
• SByte2XmlSerializer.cs (modified) (1 diff)
• Short2XmlSerializer.cs (modified) (1 diff)
• SimpleNumber2XmlSerializerBase.cs (modified) (1 diff)
• String2XmlSerializer.cs (modified) (2 diffs)
• System.Drawing/Bitmap2XmlSerializer.cs (modified) (1 diff)
• TimeSpan2XmlSerializer.cs (modified) (1 diff)
• UInt2XmlSerializer.cs (modified) (1 diff)
• ULong2XmlSerializer.cs (modified) (1 diff)
• UShort2XmlSerializer.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Bool2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Bool2XmlSerializer : SimpleNumber2XmlSerializerBase<bool> { }
+  internal sealed class Bool2XmlSerializer : SimpleNumber2XmlSerializerBase<bool> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Byte2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Byte2XmlSerializer : SimpleNumber2XmlSerializerBase<byte> { }
+  internal sealed class Byte2XmlSerializer : SimpleNumber2XmlSerializerBase<byte> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Char2XmlFormatter.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Char2XmlSerializer : PrimitiveSerializerBase<char, XmlString> {
+  internal sealed class Char2XmlSerializer : PrimitiveSerializerBase<char, XmlString> {
 
     public override XmlString Format(char c) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/DateTime2XmlSerializer.cs

@@ -5 +5 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class DateTime2XmlSerializer : PrimitiveXmlSerializerBase<DateTime> {
+  internal sealed class DateTime2XmlSerializer : PrimitiveXmlSerializerBase<DateTime> {
 
     public override XmlString Format(DateTime dt) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Decimal2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Decimal2XmlSerializer : PrimitiveXmlSerializerBase<decimal> {
+  internal sealed class Decimal2XmlSerializer : PrimitiveXmlSerializerBase<decimal> {
 
     public static decimal ParseG30(string s) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Double2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Double2XmlSerializer : PrimitiveXmlSerializerBase<double> {
+  internal sealed class Double2XmlSerializer : PrimitiveXmlSerializerBase<double> {
 
     public static double ParseG17(string s) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Float2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Float2XmlSerializer : PrimitiveXmlSerializerBase<float> {
+  internal sealed class Float2XmlSerializer : PrimitiveXmlSerializerBase<float> {
 
     public static float ParseG8(string s) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Guid2XmlSerializer.cs

@@ -9 +9 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Guid2XmlSerializer : PrimitiveXmlSerializerBase<Guid> {
+  internal sealed class Guid2XmlSerializer : PrimitiveXmlSerializerBase<Guid> {
 
     public override XmlString Format(Guid o) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Int2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Int2XmlSerializer : SimpleNumber2XmlSerializerBase<int> { }
+  internal sealed class Int2XmlSerializer : SimpleNumber2XmlSerializerBase<int> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Long2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Long2XmlSerializer : SimpleNumber2XmlSerializerBase<long> { }
+  internal sealed class Long2XmlSerializer : SimpleNumber2XmlSerializerBase<long> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/PrimitiveXmlSerializerBase.cs

@@ -5 +5 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
+  /// <summary>
+  /// Common base class for primitive XML serializers.
+  /// </summary>
+  /// <typeparam name="T">The source type being serialized to XMl.</typeparam>
   public abstract class PrimitiveXmlSerializerBase<T> : XmlSerializerBase<T> { }
 

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/SByte2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class SByte2XmlSerializer : SimpleNumber2XmlSerializerBase<sbyte> { }
+  internal sealed class SByte2XmlSerializer : SimpleNumber2XmlSerializerBase<sbyte> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/Short2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class Short2XmlSerializer : SimpleNumber2XmlSerializerBase<short> { }
+  internal sealed class Short2XmlSerializer : SimpleNumber2XmlSerializerBase<short> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/SimpleNumber2XmlSerializerBase.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public abstract class SimpleNumber2XmlSerializerBase<T> : PrimitiveXmlSerializerBase<T> {
+  internal abstract class SimpleNumber2XmlSerializerBase<T> : PrimitiveXmlSerializerBase<T> {
 
     private static MethodInfo ParseMethod = typeof(T)

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/String2XmlSerializer.cs

@@ -9 +9 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class String2XmlSerializer : PrimitiveXmlSerializerBase<string> {
+  /// <summary>
+  /// Serializes a string to XML by embedding into a CDATA block.
+  /// </summary>
+  public sealed class String2XmlSerializer : PrimitiveXmlSerializerBase<string> {
 
+    /// <summary>
+    /// Formats the specified string.
+    /// </summary>
+    /// <param name="s">The string.</param>
+    /// <returns>An XmlString that embeds the string s in a CDATA section.</returns>
     public override XmlString Format(string s) {
       StringBuilder sb = new StringBuilder();
@@ -21 +29 @@
     private static Regex re = new Regex(@"<!\[CDATA\[((?:[^]]|\](?!\]>))*)\]\]>", RegexOptions.Singleline);
 
+    /// <summary>
+    /// Parses the specified XmlString into a string.
+    /// </summary>
+    /// <param name="x">The XMLString.</param>
+    /// <returns>The plain string contained in the XML CDATA section.</returns>
     public override string Parse(XmlString x) {
       StringBuilder sb = new StringBuilder();

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/System.Drawing/Bitmap2XmlSerializer.cs

@@ -11 +11 @@
 
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
-  public class Bitmap2XmlSerializer : PrimitiveXmlSerializerBase<Bitmap> {
+  internal sealed class Bitmap2XmlSerializer : PrimitiveXmlSerializerBase<Bitmap> {
 
     public override XmlString Format(Bitmap o) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/TimeSpan2XmlSerializer.cs

@@ -9 +9 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class TimeSpan2XmlSerializer : PrimitiveXmlSerializerBase<TimeSpan> {
+  internal sealed class TimeSpan2XmlSerializer : PrimitiveXmlSerializerBase<TimeSpan> {
 
     public override XmlString Format(TimeSpan o) {

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/UInt2XmlSerializer.cs

@@ -8 +8 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class UInt2XmlSerializer : SimpleNumber2XmlSerializerBase<uint> { }
+  internal sealed class UInt2XmlSerializer : SimpleNumber2XmlSerializerBase<uint> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/ULong2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class ULong2XmlSerializer : SimpleNumber2XmlSerializerBase<ulong> { }
+  internal sealed class ULong2XmlSerializer : SimpleNumber2XmlSerializerBase<ulong> { }
 
 }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Primitive/UShort2XmlSerializer.cs

@@ -7 +7 @@
 namespace HeuristicLab.Persistence.Default.Xml.Primitive {
 
-  public class UShort2XmlSerializer : SimpleNumber2XmlSerializerBase<ushort> { }
+  internal sealed class UShort2XmlSerializer : SimpleNumber2XmlSerializerBase<ushort> { }
 
 }