Free cookie consent management tool by TermsFeed Policy Generator

Ignore:
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/Xml
Files:
33 edited

Legend:

Unmodified
Added
Removed

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/ByteArray2XmlSerializer.cs

    r2940 r3036  
    55
    66namespace HeuristicLab.Persistence.Default.Xml.Compact {
    7   public class ByteArray2XmlSerializer<T> : NumberArray2XmlSerializerBase<T> where T : class {
     7  internal class ByteArray2XmlSerializer<T> : NumberArray2XmlSerializerBase<T> where T : class {
    88    protected override string FormatValue(object o) {
    99      return o.ToString();
    … …  
    1515  }
    1616
    17   public class Byte1DArray2XmlSerializer : ByteArray2XmlSerializer<byte[]> { }
     17  internal sealed class Byte1DArray2XmlSerializer : ByteArray2XmlSerializer<byte[]> { }
    1818
    19   public class Bytet2DArray2XmlSerializer : ByteArray2XmlSerializer<byte[,]> { }
     19  internal sealed class Bytet2DArray2XmlSerializer : ByteArray2XmlSerializer<byte[,]> { }
    2020
    21   public class Byte3DArray2XmlSerializer : ByteArray2XmlSerializer<byte[, ,]> { }
     21  internal sealed class Byte3DArray2XmlSerializer : ByteArray2XmlSerializer<byte[, ,]> { }
    2222}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/CompactXmlSerializerBase.cs

    r1823 r3036  
    55namespace HeuristicLab.Persistence.Default.Xml.Compact {
    66
    7   public abstract class CompactXmlSerializerBase<T> : XmlSerializerBase<T> { }
     7  internal abstract class CompactXmlSerializerBase<T> : XmlSerializerBase<T> { }
    88
    99}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/DoubleArray2XmlSerializer.cs

    r1958 r3036  
    55namespace HeuristicLab.Persistence.Default.Xml.Compact {
    66
    7   public abstract class DoubleArray2XmlSerializerBase<T> : NumberArray2XmlSerializerBase<T> where T : class {
     7  internal abstract class DoubleArray2XmlSerializerBase<T> : NumberArray2XmlSerializerBase<T> where T : class {
    88
    99    protected override string FormatValue(object o) {
    … …  
    1616  }
    1717
    18   public class Double1DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[]> { }
     18  internal sealed class Double1DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[]> { }
    1919
    20   public class Double2DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[,]> { }
     20  internal sealed class Double2DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[,]> { }
    2121
    22   public class Double3DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[, ,]> { }
     22  internal sealed class Double3DArray2XmlSerializer : DoubleArray2XmlSerializerBase<double[, ,]> { }
    2323
    2424}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/DoubleList2XmlSerializer.cs

    r1958 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Compact {
    88
    9   public class DoubleList2XmlSerializer : NumberEnumeration2XmlSerializerBase<List<double>> {
     9  internal sealed class DoubleList2XmlSerializer : NumberEnumeration2XmlSerializerBase<List<double>> {
    1010
    1111    protected override void Add(IEnumerable enumeration, object o) {

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/IntArray2XmlSerializer.cs

    r1853 r3036  
    44namespace HeuristicLab.Persistence.Default.Xml.Compact {
    55
    6   public abstract class IntArray2XmlSerializerBase<T> : NumberArray2XmlSerializerBase<T> where T : class {
     6  internal abstract class IntArray2XmlSerializerBase<T> : NumberArray2XmlSerializerBase<T> where T : class {
    77
    88    protected override string FormatValue(object o) {
    … …  
    1515  }
    1616
    17   public class Int1DArray2XmlSerializer : IntArray2XmlSerializerBase<int[]> { }
     17  internal class Int1DArray2XmlSerializer : IntArray2XmlSerializerBase<int[]> { }
    1818
    19   public class Int2DArray2XmlSerializer : IntArray2XmlSerializerBase<int[,]> { }
     19  internal class Int2DArray2XmlSerializer : IntArray2XmlSerializerBase<int[,]> { }
    2020
    21   public class Int3DArray2XmlSerializer : IntArray2XmlSerializerBase<int[, ,]> { }
     21  internal class Int3DArray2XmlSerializer : IntArray2XmlSerializerBase<int[, ,]> { }
    2222
    2323}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/IntList2XmlSerializer.cs

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Compact {
    88
    9   public class IntList2XmlSerializer : NumberEnumeration2XmlSerializerBase<List<int>> {
     9  internal sealed class IntList2XmlSerializer : NumberEnumeration2XmlSerializerBase<List<int>> {
    1010
    1111    protected override void Add(IEnumerable enumeration, object o) {

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/NumberArray2XmlSerializerBase.cs

    r3017 r3036  
    99
    1010  [StorableClass]
    11   public abstract class NumberArray2XmlSerializerBase<T> : CompactXmlSerializerBase<T> where T : class {
     11  internal abstract class NumberArray2XmlSerializerBase<T> : CompactXmlSerializerBase<T> where T : class {
    1212
    1313    protected virtual string Separator { get { return ";"; } }

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/Compact/NumberEnumeration2XmlSerializerBase.cs

    r3017 r3036  
    99
    1010  [StorableClass]
    11   public abstract class NumberEnumeration2XmlSerializerBase<T> : CompactXmlSerializerBase<T> where T : IEnumerable {
     11  internal abstract class NumberEnumeration2XmlSerializerBase<T> : CompactXmlSerializerBase<T> where T : IEnumerable {
    1212
    1313    protected virtual string Separator { get { return ";"; } }

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Bool2XmlSerializer : SimpleNumber2XmlSerializerBase<bool> { }
     9  internal sealed class Bool2XmlSerializer : SimpleNumber2XmlSerializerBase<bool> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Byte2XmlSerializer : SimpleNumber2XmlSerializerBase<byte> { }
     9  internal sealed class Byte2XmlSerializer : SimpleNumber2XmlSerializerBase<byte> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Char2XmlSerializer : PrimitiveSerializerBase<char, XmlString> {
     9  internal sealed class Char2XmlSerializer : PrimitiveSerializerBase<char, XmlString> {
    1010
    1111    public override XmlString Format(char c) {

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

    r1853 r3036  
    55namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    66
    7   public class DateTime2XmlSerializer : PrimitiveXmlSerializerBase<DateTime> {
     7  internal sealed class DateTime2XmlSerializer : PrimitiveXmlSerializerBase<DateTime> {
    88
    99    public override XmlString Format(DateTime dt) {

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

    r1958 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Decimal2XmlSerializer : PrimitiveXmlSerializerBase<decimal> {
     9  internal sealed class Decimal2XmlSerializer : PrimitiveXmlSerializerBase<decimal> {
    1010
    1111    public static decimal ParseG30(string s) {

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

    r1958 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Double2XmlSerializer : PrimitiveXmlSerializerBase<double> {
     9  internal sealed class Double2XmlSerializer : PrimitiveXmlSerializerBase<double> {
    1010
    1111    public static double ParseG17(string s) {

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

    r1958 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Float2XmlSerializer : PrimitiveXmlSerializerBase<float> {
     9  internal sealed class Float2XmlSerializer : PrimitiveXmlSerializerBase<float> {
    1010
    1111    public static float ParseG8(string s) {

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

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    1010
    11   public class Guid2XmlSerializer : PrimitiveXmlSerializerBase<Guid> {
     11  internal sealed class Guid2XmlSerializer : PrimitiveXmlSerializerBase<Guid> {
    1212
    1313    public override XmlString Format(Guid o) {

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Int2XmlSerializer : SimpleNumber2XmlSerializerBase<int> { }
     9  internal sealed class Int2XmlSerializer : SimpleNumber2XmlSerializerBase<int> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Long2XmlSerializer : SimpleNumber2XmlSerializerBase<long> { }
     9  internal sealed class Long2XmlSerializer : SimpleNumber2XmlSerializerBase<long> { }
    1010
    1111}

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

    r1823 r3036  
    55namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    66
     7  /// <summary>
     8  /// Common base class for primitive XML serializers.
     9  /// </summary>
     10  /// <typeparam name="T">The source type being serialized to XMl.</typeparam>
    711  public abstract class PrimitiveXmlSerializerBase<T> : XmlSerializerBase<T> { }
    812

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class SByte2XmlSerializer : SimpleNumber2XmlSerializerBase<sbyte> { }
     9  internal sealed class SByte2XmlSerializer : SimpleNumber2XmlSerializerBase<sbyte> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class Short2XmlSerializer : SimpleNumber2XmlSerializerBase<short> { }
     9  internal sealed class Short2XmlSerializer : SimpleNumber2XmlSerializerBase<short> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public abstract class SimpleNumber2XmlSerializerBase<T> : PrimitiveXmlSerializerBase<T> {
     9  internal abstract class SimpleNumber2XmlSerializerBase<T> : PrimitiveXmlSerializerBase<T> {
    1010
    1111    private static MethodInfo ParseMethod = typeof(T)

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

    r2940 r3036  
    99namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    1010
    11   public class String2XmlSerializer : PrimitiveXmlSerializerBase<string> {
     11  /// <summary>
     12  /// Serializes a string to XML by embedding into a CDATA block.
     13  /// </summary>
     14  public sealed class String2XmlSerializer : PrimitiveXmlSerializerBase<string> {
    1215
     16    /// <summary>
     17    /// Formats the specified string.
     18    /// </summary>
     19    /// <param name="s">The string.</param>
     20    /// <returns>An XmlString that embeds the string s in a CDATA section.</returns>
    1321    public override XmlString Format(string s) {
    1422      StringBuilder sb = new StringBuilder();
    … …  
    2129    private static Regex re = new Regex(@"<!\[CDATA\[((?:[^]]|\](?!\]>))*)\]\]>", RegexOptions.Singleline);
    2230
     31    /// <summary>
     32    /// Parses the specified XmlString into a string.
     33    /// </summary>
     34    /// <param name="x">The XMLString.</param>
     35    /// <returns>The plain string contained in the XML CDATA section.</returns>
    2336    public override string Parse(XmlString x) {
    2437      StringBuilder sb = new StringBuilder();

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

    r3004 r3036  
    1111
    1212namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    13   public class Bitmap2XmlSerializer : PrimitiveXmlSerializerBase<Bitmap> {
     13  internal sealed class Bitmap2XmlSerializer : PrimitiveXmlSerializerBase<Bitmap> {
    1414
    1515    public override XmlString Format(Bitmap o) {

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

    r1853 r3036  
    99namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    1010
    11   public class TimeSpan2XmlSerializer : PrimitiveXmlSerializerBase<TimeSpan> {
     11  internal sealed class TimeSpan2XmlSerializer : PrimitiveXmlSerializerBase<TimeSpan> {
    1212
    1313    public override XmlString Format(TimeSpan o) {

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

    r1853 r3036  
    88namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    99
    10   public class UInt2XmlSerializer : SimpleNumber2XmlSerializerBase<uint> { }
     10  internal sealed class UInt2XmlSerializer : SimpleNumber2XmlSerializerBase<uint> { }
    1111
    1212}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class ULong2XmlSerializer : SimpleNumber2XmlSerializerBase<ulong> { }
     9  internal sealed class ULong2XmlSerializer : SimpleNumber2XmlSerializerBase<ulong> { }
    1010
    1111}

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

    r1853 r3036  
    77namespace HeuristicLab.Persistence.Default.Xml.Primitive {
    88
    9   public class UShort2XmlSerializer : SimpleNumber2XmlSerializerBase<ushort> { }
     9  internal sealed class UShort2XmlSerializer : SimpleNumber2XmlSerializerBase<ushort> { }
    1010
    1111}

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlFormat.cs

    r3017 r3036  
    1111  [StorableClass]
    1212  public class XmlFormat : FormatBase<XmlString> {
     13    /// <summary>
     14    /// Gets the format's name.
     15    /// </summary>
     16    /// <value>The format's name.</value>
    1317    public override string Name { get { return "XML"; } }
    1418  }

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs

    r3028 r3036  
    112112    }
    113113
     114    /// <summary>
     115    /// Formats the specified begin token.
     116    /// </summary>
     117    /// <param name="beginToken">The begin token.</param>
     118    /// <returns>The token in serialized form.</returns>
    114119    protected override string Format(BeginToken beginToken) {
    115120      var dict = new Dictionary<string, object> {
    … …  
    134139    }
    135140
     141    /// <summary>
     142    /// Formats the specified end token.
     143    /// </summary>
     144    /// <param name="endToken">The end token.</param>
     145    /// <returns>The token in serialized form.</returns>
    136146    protected override string Format(EndToken endToken) {
    137147      return CreateNodeEnd(XmlStringConstants.COMPOSITE);
    138148    }
    139149
     150    /// <summary>
     151    /// Formats the specified data token.
     152    /// </summary>
     153    /// <param name="dataToken">The data token.</param>
     154    /// <returns>The token in serialized form.</returns>
    140155    protected override string Format(PrimitiveToken dataToken) {
    141156      var dict = new Dictionary<string, object> {
    … …  
    148163    }
    149164
     165    /// <summary>
     166    /// Formats the specified ref token.
     167    /// </summary>
     168    /// <param name="refToken">The ref token.</param>
     169    /// <returns>The token in serialized form.</returns>
    150170    protected override string Format(ReferenceToken refToken) {
    151171      return CreateNode(XmlStringConstants.REFERENCE,
    … …  
    155175    }
    156176
     177    /// <summary>
     178    /// Formats the specified null ref token.
     179    /// </summary>
     180    /// <param name="nullRefToken">The null ref token.</param>
     181    /// <returns>The token in serialized form.</returns>
    157182    protected override string Format(NullReferenceToken nullRefToken) {
    158183      return CreateNode(XmlStringConstants.NULL,
    … …  
    161186    }
    162187
     188    /// <summary>
     189    /// Formats the specified meta info begin token.
     190    /// </summary>
     191    /// <param name="metaInfoBeginToken">The meta info begin token.</param>
     192    /// <returns>The token in serialized form.</returns>
    163193    protected override string Format(MetaInfoBeginToken metaInfoBeginToken) {
    164194      return CreateNodeStart(XmlStringConstants.METAINFO);
    165195    }
    166196
     197    /// <summary>
     198    /// Formats the specified meta info end token.
     199    /// </summary>
     200    /// <param name="metaInfoEndToken">The meta info end token.</param>
     201    /// <returns>The token in serialized form.</returns>
    167202    protected override string Format(MetaInfoEndToken metaInfoEndToken) {
    168203      return CreateNodeEnd(XmlStringConstants.METAINFO);
    … …  
    170205
    171206    private TypeToken lastTypeToken;
     207    /// <summary>
     208    /// Formats the specified token.
     209    /// </summary>
     210    /// <param name="token">The token.</param>
     211    /// <returns>The token in serialized form.</returns>
    172212    protected override string Format(TypeToken token) {
    173213      lastTypeToken = token;
    … …  
    205245    /// <summary>
    206246    /// Serialize an object into a file.
    207     ///
    208247    /// The XML configuration is obtained from the <c>ConfigurationService</c>.
    209248    /// The file is actually a ZIP file.
    210249    /// Compression level is set to 5 and needed assemblies are not included.
    211     /// </summary>   
     250    /// </summary>
     251    /// <param name="o">The object.</param>
     252    /// <param name="filename">The filename.</param>
    212253    public static void Serialize(object o, string filename) {
    213254      Serialize(o, filename, ConfigurationService.Instance.GetConfiguration(new XmlFormat()), false, 5);

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlSerializerBase.cs

    r1823 r3036  
    44
    55namespace HeuristicLab.Persistence.Default.Xml {
    6  
     6
     7  /// <summary>
     8  /// Common base class for all primitive XML Serializers.
     9  /// </summary>
     10  /// <typeparam name="T">The source type being serialized to XML.</typeparam>
    711  public abstract class XmlSerializerBase<T> : PrimitiveSerializerBase<T, XmlString> { }
    812

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlString.cs

    r3017 r3036  
    66namespace HeuristicLab.Persistence.Default.Xml {
    77
     8  /// <summary>
     9  /// XML friendly encapsulation of string data.
     10  /// </summary>
    811  [StorableClass] 
    912  public class XmlString : ISerialData {
    1013
     14    /// <summary>
     15    /// Gets the XML string data. Essentially marks the string as
     16    /// XML compatible string.
     17    /// </summary>
     18    /// <value>The XML string data.</value>
    1119    [Storable]
    1220    public string Data { get; private set; }
    … …  
    1422    private XmlString() { }
    1523
     24    /// <summary>
     25    /// Initializes a new instance of the <see cref="XmlString"/> class.
     26    /// </summary>
     27    /// <param name="data">The xml data.</param>
    1628    public XmlString(string data) {
    1729      Data = data;
    1830    }
    1931
     32    /// <summary>
     33    /// Returns a <see cref="System.String"/> that represents this instance.
     34    /// </summary>
     35    /// <returns>
     36    /// A <see cref="System.String"/> that represents this instance.
     37    /// </returns>
    2038    public override string ToString() {
    2139      StringBuilder sb = new StringBuilder();

  • trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlStringConstants.cs

    r2718 r3036  
    1111namespace HeuristicLab.Persistence.Default.Xml {
    1212
    13   struct XmlStringConstants {
     13  internal struct XmlStringConstants {
    1414    public const string PRIMITIVE = "PRIMITIVE";
    1515    public const string COMPOSITE = "COMPOSITE";
Note: See TracChangeset for help on using the changeset viewer.