System::Xml::XmlNamespaceManager Class Reference

Resolves, adds, and removes namespaces to a collection and provides scope management for these namespaces. More...

#include "xml_namespace_manager.h"

Inherits System::Xml::IXmlNamespaceResolver, and System::Collections::Generic::IEnumerable< String >.

Inherited by System::Xml::Xsl::XsltContext.

Public Types

using Ptr = SharedPtr< XmlNamespaceManager >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< String >
typedef IEnumerator< StringIEnumeratorType
 Enumerator type. More...
 
using ValueType = String
 
using iterator = System::Details::VirtualizedIterator< String >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< String >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< String >
 Inner iterator base type. More...
 
using virtualized_iterator_element = String
 Inner iterator element type. More...
 

Public Member Functions

virtual ASPOSECPP_SHARED_API SharedPtr< XmlNameTableget_NameTable ()
 Returns the XmlNameTable associated with this object. More...
 
virtual ASPOSECPP_SHARED_API String get_DefaultNamespace ()
 Returns the namespace URI for the default namespace. More...
 
ASPOSECPP_SHARED_API XmlNamespaceManager (const SharedPtr< XmlNameTable > &nameTable)
 Initializes a new instance of the XmlNamespaceManager class with the specified XmlNameTable. More...
 
virtual ASPOSECPP_SHARED_API void PushScope ()
 Pushes a namespace scope onto the stack. More...
 
virtual ASPOSECPP_SHARED_API bool PopScope ()
 Pops a namespace scope off the stack. More...
 
virtual ASPOSECPP_SHARED_API void AddNamespace (String prefix, String uri)
 Adds the given namespace to the collection. More...
 
virtual ASPOSECPP_SHARED_API void RemoveNamespace (String prefix, String uri)
 Removes the given namespace for the given prefix. More...
 
ASPOSECPP_SHARED_API SharedPtr< Collections::Generic::IEnumerator< String > > GetEnumerator () override
 Returns an enumerator to use to iterate through the namespaces in the XmlNamespaceManager. More...
 
ASPOSECPP_SHARED_API SharedPtr< Collections::Generic::IDictionary< String, String > > GetNamespacesInScope (XmlNamespaceScope scope) override
 Returns a collection of namespace names keyed by prefix which can be used to enumerate the namespaces currently in scope. More...
 
ASPOSECPP_SHARED_API String LookupNamespace (const String &prefix) override
 Returns the namespace URI for the specified prefix. More...
 
ASPOSECPP_SHARED_API String LookupPrefix (const String &uri) override
 Finds the prefix declared for the given namespace URI. More...
 
virtual ASPOSECPP_SHARED_API bool HasNamespace (String prefix)
 Returns a value indicating whether the supplied prefix has a namespace defined for the current pushed scope. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< String >
String LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
String LINQ_First ()
 Returns the first element of a sequence. More...
 
String LINQ_First (const Func< String, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
String LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
String LINQ_FirstOrDefault (std::function< bool(String)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
String LINQ_Last ()
 Returns the last element of a sequence. More...
 
String LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< String > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< String, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< StringLINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(String)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(String)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< String > > LINQ_Where (std::function< bool(String)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (String value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< String > > LINQ_OrderBy (const Func< String, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< String > > LINQ_OrderByDescending (const Func< String, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< String, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< String, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< String > > LINQ_Concat (SharedPtr< IEnumerable< String >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, String > > > > LINQ_GroupBy (System::Func< String, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< String, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin ()
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end ()
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 

Protected Member Functions

virtual ASPOSECPP_SHARED_API ~XmlNamespaceManager ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< String >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Resolves, adds, and removes namespaces to a collection and provides scope management for these namespaces.

Attention
Objects of this class should only be allocated using System::MakeObject() function. Never create instances of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ XmlNamespaceManager()

ASPOSECPP_SHARED_API System::Xml::XmlNamespaceManager::XmlNamespaceManager ( const SharedPtr< XmlNameTable > &  nameTable)

Initializes a new instance of the XmlNamespaceManager class with the specified XmlNameTable.

Parameters
nameTableThe XmlNameTable to use.
Exceptions
NullReferenceExceptionnullptr is passed to the constructor.

◆ ~XmlNamespaceManager()

virtual ASPOSECPP_SHARED_API System::Xml::XmlNamespaceManager::~XmlNamespaceManager ( )
protectedvirtual

Member Function Documentation

◆ AddNamespace()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNamespaceManager::AddNamespace ( String  prefix,
String  uri 
)
virtual

Adds the given namespace to the collection.

Parameters
prefixThe prefix to associate with the namespace being added. Use String::Empty to add a default namespace. If the XmlNamespaceManager will be used for resolving namespaces in an XML Path Language (XPath) expression, a prefix must be specified. If an XPath expression does not include a prefix, it is assumed that the namespace Uniform Resource Identifier (URI) is the empty namespace. For more information about XPath expressions and the XmlNamespaceManager, refer to the XmlNode::SelectNodes(String) and XPathExpression::SetContext(SharedPtr<XmlNamespaceManager>) methods.
uriThe namespace to add.
Exceptions
ArgumentExceptionThe value for prefix is "xml" or "xmlns".
ArgumentNullExceptionThe value for prefix or uri is nullptr.

◆ get_DefaultNamespace()

virtual ASPOSECPP_SHARED_API String System::Xml::XmlNamespaceManager::get_DefaultNamespace ( )
virtual

Returns the namespace URI for the default namespace.

Returns
The namespace URI for the default namespace, or an empty string if there is no default namespace.

◆ get_NameTable()

virtual ASPOSECPP_SHARED_API SharedPtr<XmlNameTable> System::Xml::XmlNamespaceManager::get_NameTable ( )
virtual

Returns the XmlNameTable associated with this object.

Returns
The XmlNameTable used by this object.

◆ GetEnumerator()

ASPOSECPP_SHARED_API SharedPtr<Collections::Generic::IEnumerator<String> > System::Xml::XmlNamespaceManager::GetEnumerator ( )
overridevirtual

Returns an enumerator to use to iterate through the namespaces in the XmlNamespaceManager.

Returns
An IEnumerator containing the prefixes stored by the XmlNamespaceManager.

Implements System::Collections::Generic::IEnumerable< String >.

◆ GetNamespacesInScope()

ASPOSECPP_SHARED_API SharedPtr<Collections::Generic::IDictionary<String, String> > System::Xml::XmlNamespaceManager::GetNamespacesInScope ( XmlNamespaceScope  scope)
overridevirtual

Returns a collection of namespace names keyed by prefix which can be used to enumerate the namespaces currently in scope.

Parameters
scopeAn enumeration value that specifies the type of namespace nodes to return.
Returns
A collection of namespace and prefix pairs currently in scope.

Implements System::Xml::IXmlNamespaceResolver.

◆ HasNamespace()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlNamespaceManager::HasNamespace ( String  prefix)
virtual

Returns a value indicating whether the supplied prefix has a namespace defined for the current pushed scope.

Parameters
prefixThe prefix of the namespace you want to find.
Returns
true if there is a namespace defined; otherwise, false.

◆ LookupNamespace()

ASPOSECPP_SHARED_API String System::Xml::XmlNamespaceManager::LookupNamespace ( const String prefix)
overridevirtual

Returns the namespace URI for the specified prefix.

Parameters
prefixThe prefix whose namespace URI you want to resolve. To match the default namespace, pass String::Empty.
Returns
The namespace URI for prefix or nullptr if there is no mapped namespace. The returned string is atomized. For more information on atomized strings, see the XmlNameTable class.

Implements System::Xml::IXmlNamespaceResolver.

◆ LookupPrefix()

ASPOSECPP_SHARED_API String System::Xml::XmlNamespaceManager::LookupPrefix ( const String uri)
overridevirtual

Finds the prefix declared for the given namespace URI.

Parameters
uriThe namespace to resolve for the prefix.
Returns
The matching prefix. If there is no mapped prefix, the method returns String::Empty. If a null value is supplied, then nullptr is returned.

Implements System::Xml::IXmlNamespaceResolver.

◆ PopScope()

virtual ASPOSECPP_SHARED_API bool System::Xml::XmlNamespaceManager::PopScope ( )
virtual

Pops a namespace scope off the stack.

Returns
true if there are namespace scopes left on the stack; false if there are no more namespaces to pop.

◆ PushScope()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNamespaceManager::PushScope ( )
virtual

Pushes a namespace scope onto the stack.

◆ RemoveNamespace()

virtual ASPOSECPP_SHARED_API void System::Xml::XmlNamespaceManager::RemoveNamespace ( String  prefix,
String  uri 
)
virtual

Removes the given namespace for the given prefix.

Parameters
prefixThe prefix for the namespace.
uriThe namespace to remove for the given prefix. The namespace removed is from the current namespace scope. Namespaces outside the current scope are ignored.
Exceptions
ArgumentNullExceptionThe value of prefix or uri is nullptr.