Class HierarchyDecoratorExtensions

Namespace

Cuemon.Xml

Assembly

Cuemon.Xml.dll

Extension methods for the IHierarchy<T> interface hidden behind the IDecorator<T> interface.

public static class HierarchyDecoratorExtensions

Inheritance

object

HierarchyDecoratorExtensions

Examples

HierarchyDecoratorExtensions provides extension methods on Decorator.Enclose for inspecting XML serialization metadata on IHierarchy<object> nodes. This example creates a Hierarchy<object> tree with a Person node (annotated with [XmlRoot("person")]) and an Address child node, then uses decorator methods to call GetXmlQualifiedEntity, TryGetXmlRootAttribute, TryGetXmlElementAttribute, TryGetXmlTextAttribute, TryGetXmlAttributeAttribute, IsNodeEnumerable, HasXmlIgnoreAttribute, and OrderByXmlAttributes. Console output displays the qualified entity local name, boolean results for attribute detection, and the count of ordered nodes.

using System;
using Cuemon;
using Cuemon.Extensions.Runtime;
using Cuemon.Xml;
using System.Collections.Generic;
using System.Linq;
using System.Xml.Serialization;

namespace MyApp.Examples;

public static class HierarchyDecoratorExtensionsExample
{
    public static void Demonstrate()
    {
        var hierarchy = new Hierarchy<object>();
        var root = hierarchy.Add(new Person { Name = "Alice" });
        var child = root.Add(new Address { City = "Paris" });

        var decorator = Decorator.Enclose((IHierarchy<object>)child);
        var rootDecorator = Decorator.Enclose((IHierarchy<object>)root);
        var qualifiedEntity = decorator.GetXmlQualifiedEntity();
        var hasRoot = rootDecorator.TryGetXmlRootAttribute(out _);
        var hasElement = decorator.TryGetXmlElementAttribute(out _);
        var hasText = decorator.TryGetXmlTextAttribute(out _);
        var hasAttribute = decorator.TryGetXmlAttributeAttribute(out _);
        var ordered = Decorator.Enclose((IEnumerable<IHierarchy<object>>)new[] { root, child }).OrderByXmlAttributes<object>().ToList();

        Console.WriteLine(qualifiedEntity.LocalName);
        Console.WriteLine(hasRoot);
        Console.WriteLine(hasElement || hasText || hasAttribute);
        Console.WriteLine(decorator.IsNodeEnumerable());
        Console.WriteLine(decorator.HasXmlIgnoreAttribute());
        Console.WriteLine(ordered.Count);
    }

    [XmlRoot("person")]
    private sealed class Person
    {
        public string Name { get; set; }
    }

    private sealed class Address
    {
        public string City { get; set; }
    }
}

Methods

GetXmlQualifiedEntity(IDecorator<IHierarchy<object>>, XmlQualifiedEntity)

Resolves an XmlQualifiedEntity from either the specified qualifiedEntity or from the underlying IHierarchy{object} of the decorator.

public static XmlQualifiedEntity GetXmlQualifiedEntity(this IDecorator<IHierarchy<object>> decorator, XmlQualifiedEntity qualifiedEntity = null)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

qualifiedEntity XmlQualifiedEntity

The optional XmlQualifiedEntity that is part of the equation.

Returns

XmlQualifiedEntity

An XmlQualifiedEntity that is either from qualifiedEntity, embedded within decorator, XmlRootAttribute, XmlElementAttribute, XmlAttributeAttribute or resolved from either member name or member type (in that order).

Exceptions

ArgumentNullException

decorator cannot be null.

HasXmlIgnoreAttribute(IDecorator<IHierarchy<object>>)

Determines whether the underlying IHierarchy{object} of the decorator implements XmlIgnoreAttribute.

public static bool HasXmlIgnoreAttribute(this IDecorator<IHierarchy<object>> decorator)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

Returns

bool

true if the underlying IHierarchy{object} of the decorator implements XmlIgnoreAttribute; otherwise, false.

Exceptions

ArgumentNullException

decorator cannot be null.

IsNodeEnumerable(IDecorator<IHierarchy<object>>)

Determines whether the underlying IHierarchy{object} of the decorator implements either IEnumerable or IEnumerable<T> and is not a string.

public static bool IsNodeEnumerable(this IDecorator<IHierarchy<object>> decorator)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

Returns

bool

true if the underlying IHierarchy{object} of the decorator implements either IEnumerable or IEnumerable<T> and is not a string; otherwise, false.

Exceptions

ArgumentNullException

decorator cannot be null.

OrderByXmlAttributes<T>(IDecorator<IEnumerable<IHierarchy<T>>>)

Orders a sequence of IHierarchy<T> from the underlying IEnumerable{IHierarchy{object}} of the decorator by nodes having an XmlAttributeAttribute decoration.

public static IEnumerable<IHierarchy<T>> OrderByXmlAttributes<T>(this IDecorator<IEnumerable<IHierarchy<T>>> decorator)

Parameters

decorator IDecorator<IEnumerable<IHierarchy<T>>>

The IDecorator{IEnumerable{IHierarchy{object}}} to extend.

Returns

IEnumerable<IHierarchy<T>>

A sequence of IHierarchy<T> that is sorted by nodes having an XmlAttributeAttribute decoration first.

Type Parameters

T

The type of the node represented in the hierarchical structure.

Exceptions

ArgumentNullException

decorator cannot be null.

TryGetXmlAttributeAttribute(IDecorator<IHierarchy<object>>, out XmlAttributeAttribute)

Attempts to get an XmlAttributeAttribute from the underlying IHierarchy{object} of the decorator.

public static bool TryGetXmlAttributeAttribute(this IDecorator<IHierarchy<object>> decorator, out XmlAttributeAttribute xmlAttribute)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

xmlAttribute XmlAttributeAttribute

When this method returns, contains the XmlAttributeAttribute associated with the underlying IHierarchy{object} of the decorator.

Returns

bool

true if underlying IHierarchy{object} of the decorator contains an XmlAttributeAttribute, false otherwise.

TryGetXmlElementAttribute(IDecorator<IHierarchy<object>>, out XmlElementAttribute)

Attempts to get an XmlElementAttribute from the underlying IHierarchy{object} of the decorator.

public static bool TryGetXmlElementAttribute(this IDecorator<IHierarchy<object>> decorator, out XmlElementAttribute xmlAttribute)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

xmlAttribute XmlElementAttribute

When this method returns, contains the XmlElementAttribute associated with the underlying IHierarchy{object} of the decorator.

Returns

bool

true if underlying IHierarchy{object} of the decorator contains an XmlElementAttribute, false otherwise.

TryGetXmlRootAttribute(IDecorator<IHierarchy<object>>, out XmlRootAttribute)

Attempts to get an XmlRootAttribute from the underlying IHierarchy{object} of the decorator.

public static bool TryGetXmlRootAttribute(this IDecorator<IHierarchy<object>> decorator, out XmlRootAttribute xmlAttribute)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

xmlAttribute XmlRootAttribute

When this method returns, contains the XmlRootAttribute associated with the underlying IHierarchy{object} of the decorator.

Returns

bool

true if underlying IHierarchy{object} of the decorator contains an XmlRootAttribute, false otherwise.

TryGetXmlTextAttribute(IDecorator<IHierarchy<object>>, out XmlTextAttribute)

Attempts to get an XmlTextAttribute from the underlying IHierarchy{object} of the decorator.

public static bool TryGetXmlTextAttribute(this IDecorator<IHierarchy<object>> decorator, out XmlTextAttribute xmlAttribute)

Parameters

decorator IDecorator<IHierarchy<object>>

The IDecorator{IHierarchy{object}} to extend.

xmlAttribute XmlTextAttribute

When this method returns, contains the XmlTextAttribute associated with the underlying IHierarchy{object} of the decorator.

Returns

bool

true if underlying IHierarchy{object} of the decorator contains an XmlTextAttribute, false otherwise.

See Also

IDecorator<T>

Decorator<T>