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

COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.

== Synopsis

Declared in `<balxml_decoder.h>`

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

== Description

This protocol class contain functions related to parsing XML elements. When the Decoder reads the XML document, it forwards the information about the current node as events to this protocol. There are several implementations of this protocol, depending on the type of element. The correct implementation for each type is selected by the `Decoder_SelectContext` meta‐function. Each of the functions take a `context` parameter, which contains members related to the context of the decoder.

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Decoder_ElementContext/2destructor.adoc[`~Decoder_ElementContext`] [.small]#[destructor]# [.small]#[virtual]#
| For syntactic purposes only.
| xref:BloombergLP/balxml/Decoder_ElementContext/addCharacters.adoc[`addCharacters`]  [.small]#[virtual]#
| Process the specified character data while decoding. Return 0 on success, and a non‐zero value otherwise.
| xref:BloombergLP/balxml/Decoder_ElementContext/beginParse.adoc[`beginParse`] 
| Invoked when the decoder begins parsing. Return 0 on success, and a non‐zero value otherwise.
| xref:BloombergLP/balxml/Decoder_ElementContext/endElement.adoc[`endElement`]  [.small]#[virtual]#
| Invoked when the decoder finishes parsing an element. Return 0 on success, and a non‐zero value otherwise.
| xref:BloombergLP/balxml/Decoder_ElementContext/parseAttribute.adoc[`parseAttribute`]  [.small]#[virtual]#
| Invoked when the decoder encounters an attribute. Return 0 on success, and a non‐zero value otherwise.
| xref:BloombergLP/balxml/Decoder_ElementContext/parseSubElement.adoc[`parseSubElement`]  [.small]#[virtual]#
| Invoked when the decoder encounters a sub‐element. Return 0 on success, and a non‐zero value otherwise.
| xref:BloombergLP/balxml/Decoder_ElementContext/startElement.adoc[`startElement`]  [.small]#[virtual]#
| Invoked when the decoder begins parsing an element. Return 0 on success, and a non‐zero value otherwise.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Decoder_ChoiceContext.adoc[`Decoder_ChoiceContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_NillableContext.adoc[`Decoder_NillableContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_PushParserContext.adoc[`Decoder_PushParserContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_SequenceContext.adoc[`Decoder_SequenceContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_SimpleContext.adoc[`Decoder_SimpleContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_StdStringContext.adoc[`Decoder_StdStringContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_StdVectorCharContext.adoc[`Decoder_StdVectorCharContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_UTF8Context.adoc[`Decoder_UTF8Context`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
| xref:BloombergLP/balxml/Decoder_UnknownElementContext.adoc[`Decoder_UnknownElementContext`] 
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
|===


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