[#BloombergLP-balxml-Decoder_ChoiceContext]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::Decoder_ChoiceContext
: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"]
----
template<class TYPE>
class Decoder_ChoiceContext
    : public xref:BloombergLP/balxml/Decoder_ElementContext.adoc[Decoder_ElementContext]
----

== Description

This is the context for types that fall under `bdlat_TypeCategory::Choice`.

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balxml/Decoder_ElementContext.adoc[Decoder_ElementContext]`
| COMPONENT‐PRIVATE CLASS. DO NOT USE OUTSIDE OF THIS COMPONENT.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Decoder_ChoiceContext/2constructor.adoc[`Decoder_ChoiceContext`]         [.small]#[constructor]#
| Create a choice decoding context for the specified `object` using the specified `formattingMode` to control how values are parsed.
| xref:BloombergLP/balxml/Decoder_ChoiceContext/addCharacters.adoc[`addCharacters`]  [.small]#[virtual]#
| Process the specified character data `chars` of the specified `length` while decoding a choice element. Return 0 on success and a non‐zero value if invalid characters are present.
| 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_ChoiceContext/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_ChoiceContext/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_ChoiceContext/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_ChoiceContext/startElement.adoc[`startElement`]  [.small]#[virtual]#
| Invoked when the decoder begins parsing an element. Return 0 on success, and a non‐zero value otherwise.
|===



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