[#BloombergLP-balxml-PrefixStack]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::PrefixStack
:relfileprefix: ../../
:mrdocs:

`PrefixStack` allows associating a unique integer (namespace ID) with prefix.

== Synopsis

Declared in `<balxml_prefixstack.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class PrefixStack;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/PrefixStack/2constructor-02.adoc[`PrefixStack`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/PrefixStack/2destructor.adoc[`~PrefixStack`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/balxml/PrefixStack/lookupNamespaceId.adoc[`lookupNamespaceId`] 
| Return ID of the namespace registered for the specified `prefix` or ‐1 if not registered.
| xref:BloombergLP/balxml/PrefixStack/lookupNamespacePrefix.adoc[`lookupNamespacePrefix`] 
| Return a copy of the specified `prefix` if `prefix` is registered or an empty string if `prefix` is not registered.
| xref:BloombergLP/balxml/PrefixStack/lookupNamespaceUri-06.adoc[`lookupNamespaceUri`] 
| `lookupNamespaceUri` overloads
| xref:BloombergLP/balxml/PrefixStack/namespaceIdByIndex.adoc[`namespaceIdByIndex`] 
| Return the namespace ID at the specified `index` in the prefix stack, where an `index` of 0 is the oldest ID on the stack. If `index` is negative, return the ID at position 'numPrefixes() ‐ index'. Thus, an `index` of ‐1 will return the most recent ID on the stack (i.e., the top of the stack). The behavior is undefined if `index > numPrefixes()` or `index < ‐numPrefixes()`.
| xref:BloombergLP/balxml/PrefixStack/namespacePrefixByIndex.adoc[`namespacePrefixByIndex`] 
| Return the namespace prefix at the specified `index` in the prefix stack, where an `index` of 0 is the oldest prefix on the stack. If `index` is negative, return the prefix at position 'numPrefixes() ‐ index'. Thus, an `index` of ‐1 will return the most recent prefix on the stack (i.e., the top of the stack). The behavior is undefined if `index > numPrefixes()` or `index < ‐numPrefixes()`.
| xref:BloombergLP/balxml/PrefixStack/namespaceRegistry.adoc[`namespaceRegistry`] 
| Return the pointer of `NamespaceRegistry` associated with this PrefixStack.
| xref:BloombergLP/balxml/PrefixStack/namespaceUriByIndex.adoc[`namespaceUriByIndex`] 
| Return the namespace URI at the specified `index` in the prefix stack, where an `index` of 0 is the oldest URI on the stack. If `index` is negative, return the URI at position 'numPrefixes() ‐ index'. Thus, an `index` of ‐1 will return the most recent URI on the stack (i.e., the top of the stack). The behavior is undefined if `index > numPrefixes()` or `index < ‐numPrefixes()`.
| xref:BloombergLP/balxml/PrefixStack/numPrefixes.adoc[`numPrefixes`] 
| Return the current number of prefixes in the stack.
| xref:BloombergLP/balxml/PrefixStack/popPrefixes.adoc[`popPrefixes`] 
| Remove the specified last `count` number prefixes. Return the number of actually removed prefixes.
| xref:BloombergLP/balxml/PrefixStack/print.adoc[`print`] 
| Print the content of this object to the specified `stream`. The optionally specified `fullNames` specifies how namespaces should be printed: `true` for the full names and `false` only for IDs.
| xref:BloombergLP/balxml/PrefixStack/pushPrefix.adoc[`pushPrefix`] 
| Map the specified `namespaceUri` to the specified `prefix` and return the namespace Id. New mapping eclipses previous mapping.
| xref:BloombergLP/balxml/PrefixStack/reset.adoc[`reset`] 
| Removes all prefixes from the internal collection.
| xref:BloombergLP/balxml/PrefixStack/restoreToSize.adoc[`restoreToSize`] 
| Restore stack to the specified `size`. The behavior is undefined if PrefixStack contains fewer prefixes than requested size.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#