Click here to Skip to main content
15,891,938 members
Articles / Programming Languages / XML

Yet Another XML Serialization Library for the .NET Framework

Rate me:
Please Sign up or sign in to vote.
4.92/5 (91 votes)
2 Oct 2012MIT24 min read 516K   207  
A flexible XML serialization library that lets developers design the XML file structure, and select the exception handling policy. YAXLib supports polymorphic serialization and serializing generic and non-generic collection classes and arrays.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using YAXLib;

namespace DemoApplication.SampleClasses
{
    [YAXSerializableType(Options = YAXSerializationOptions.DontSerializeNullObjects)]
    public class ClassWithOptionsSet
    {
        public string StrNotNull { get; set; }

        // the default value should not be used && no warning or errors should be reported
        [YAXErrorIfMissed(YAXExceptionTypes.Warning, DefaultValue="Salam")]
        public string StrNull { get; set; }

        [YAXErrorIfMissed(YAXExceptionTypes.Warning, DefaultValue = 123)]
        public int SomeValueType { get; set; }
    }

    [YAXSerializableType(Options = YAXSerializationOptions.SerializeNullObjects)]
    public class AnotherClassWithOptionsSet
    {
        public string StrNotNull { get; set; }
        public string StrNull { get; set; }
    }

    public class ClassWithoutOptionsSet
    {
        public string StrNotNull { get; set; }
        public string StrNull { get; set; }
    }

    public class SerializationOptionsSample
    {
        [YAXComment(@"Str2Null must NOT be serialized when it is null, even 
if the serialization options of the serializer is changed")]
        public ClassWithOptionsSet ObjectWithOptionsSet { get; set; }

        [YAXComment(@"Str2Null must be serialized when it is null, even 
if the serialization options of the serializer is changed")]
        public AnotherClassWithOptionsSet AnotherObjectWithOptionsSet { get; set; }

        [YAXComment(@"serialization of Str2Null must obey the options set 
in the serializer itself")]
        public ClassWithoutOptionsSet ObjectWithoutOptionsSet { get; set; }

        public override string ToString()
        {
            return GeneralToStringProvider.GeneralToString(this);
        }

        public static SerializationOptionsSample GetSampleInstance()
        {
            return new SerializationOptionsSample()
            {
                ObjectWithOptionsSet = new ClassWithOptionsSet()
                {
                    StrNull = null,
                    StrNotNull = "SomeString"
                },

                AnotherObjectWithOptionsSet = new AnotherClassWithOptionsSet()
                {
                    StrNull = null,
                    StrNotNull = "Some other string"
                },

                ObjectWithoutOptionsSet = new ClassWithoutOptionsSet()
                {
                    StrNull = null,
                    StrNotNull = "Another string"
                }
            };
        }

    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The MIT License


Written By
Software Developer
Australia Australia
A software designer and developer

Comments and Discussions