How to deserialize XML if the return type could be an Error or Success object

by

In situations where you have an XML stream containing one of several possible document types, you can construct an XmlSerializer for each type and call XmlSerializer.CanDeserialize(XmlReader) to successively test whether the document can be deserialized into that type. This method does not advance the XmlReader past the root element so it can be called multiple times without re-reading the stream.

For instance, you could introduce the following extension method:

public static partial class XmlSerializerExtensions
{
    public static object DeserializePolymorphicXml(this string xml, params Type[] types)
    {
        using (var textReader = new StringReader(xml))
        {
            return textReader.DeserializePolymorphicXml(types);
        }
    }

    public static object DeserializePolymorphicXml(this TextReader textReader, params Type[] types)
    {
        if (textReader == null || types == null)
            throw new ArgumentNullException();
        var settings = new XmlReaderSettings { CloseInput = false }; // Let caller close the input.
        using (var xmlReader = XmlReader.Create(textReader, settings))
        {
            foreach (var type in types)
            {
                var serializer = new XmlSerializer(type);
                if (serializer.CanDeserialize(xmlReader))
                    return serializer.Deserialize(xmlReader);
            }
        }
        throw new XmlException("Invalid root type.");
    }
}

Then use it as follows:

var xmlBody = result.ResponseBody.DeserializePolymorphicXml(typeof(SuccessResponse), typeof(FailResponse));
if (xmlBody is SuccessResponse)
{
    // Handle successful response
}
else if (xmlBody is FailResponse)
{
    // Handle failed response
}
else
{
    // unknown response
    throw new InvalidOperationException("unknown response");
}

Sample fiddle.

More Related Contents:

  1. How to Deserialize XML document
  2. Serializing private member data
  3. XML Serialization and Inherited Types
  4. DataContract XML serialization and XML attributes
  5. Serialize a nullable int
  6. Can you specify format for XmlSerialization of a datetime?
  7. XML Deserialization of collection property with code defaults
  8. Wrap properties with CData Section – XML Serialization C#
  9. XmlSerializer – There was an error reflecting type
  10. How can I serialize internal classes using XmlSerializer?
  11. Error Deserializing Xml to Object – xmlns=” was not expected
  12. Serialize an object to XElement and Deserialize it in memory
  13. How to Serialize List?
  14. Deserializing XML File with multiple element attributes – attributes are not deserializing
  15. FileMode.Open and FileMode.OpenOrCreate difference when file exists? c# bug?
  16. How do I map XML to C# objects
  17. Convert an object to an XML string
  18. Deserialize object property with StringReader vs XmlNodeReader
  19. Serializing Lists of Classes to XML
  20. Trouble serializing and deserializing multiple objects
  21. How to deserialize only part of an XML document in C#
  22. How do you use XMLSerialize for Enum typed properties in c#?
  23. How to convert JSON to XML or XML to JSON?
  24. Format XML string to print friendly XML string
  25. XElement namespaces (How to?)
  26. How to deserialize JSON with duplicate property names in the same object
  27. .net XML Serialization – Storing Reference instead of Object Copy
  28. XmlWriter to Write to a String Instead of to a File
  29. Json.NET custom serialization with JsonConverter – how to get the “default” behavior
  30. Removing nodes from an XmlDocument

Leave a Comment