I’ve found myself writing code like this quite a bit lately:

var orderElement 
    = document.Element(OrderXml.OrderElementName);
if (orderElement == null)
    var message
        = string.Format(
            "Didn't find expected child element <{0}>",
    throw new InvalidOperationException(message);

The intent is to find a specified child element, throwing an error if the element is not found.

After writing the same error checking code one or two times too many, I wrote some extension methods to make the task simpler. With the extension method RequiredElement, the above code simplifies quite a lot:

var orderElement 
    = document.RequiredElement(OrderXml.OrderElementName);

Here’s the definition for RequiredElement - as you can see, the only significant difference is in the type of exception thrown.

public static XElement RequiredElement(
    this XElement parent, 
    XName child)
        "Parent element must not be null");
    var result = parent.Element(child);
    if (result == null)
        throw new XmlFormatException(
                "Didn't find required child element {0}", 

    return result;

The related extension methods, RequiredAtribute and RequiredElements (plural) - included in the attachment - are entirely similar.

XmlFormatException is a pretty vanilla custom exception type, except for the detail of taking an Xelement as one of the parameters to its constructors - this is promptly case to IXmlLineInfo allowing the exception to properly report the location within the Xml file where the problem was detected, useful for other developers and for end users trying to solve a problem.


blog comments powered by Disqus
Next Post
NAntGraph v2.2 Released  16 Jun 2010
Prior Post
Vending Machine UX Fail  30 May 2010
Related Posts
Using Constructors  27 Feb 2023
An Inconvenient API  18 Feb 2023
Method Archetypes  11 Sep 2022
A bash puzzle, solved  02 Jul 2022
A bash puzzle  25 Jun 2022
Improve your troubleshooting by aggregating errors  11 Jun 2022
Improve your troubleshooting by wrapping errors  28 May 2022
Keep your promises  14 May 2022
When are you done?  18 Apr 2022
Fixing GitHub Authentication  28 Nov 2021
June 2010