[#BloombergLP-balxml-Formatter_State]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balxml.adoc[balxml]::Formatter&lowbar;State
:relfileprefix: ../../
:mrdocs:

This component&hyphen;private, in&hyphen;core, value&hyphen;semantic class provides a variant that can be inhabited by an object of either the component&hyphen;private `Formatter&lowbar;CompactImplState` type or the component&hyphen;private `Formatter&lowbar;PrettyImplState` type&period;

== Synopsis

Declared in `&lt;balxml&lowbar;formatter&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class Formatter&lowbar;State;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/Mode.adoc[`Mode`] 
| Formatting mode type used by this class&period;
| xref:BloombergLP/balxml/Formatter_State/allocator_type.adoc[`allocator&lowbar;type`] 
| Allocator type used by this class&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/2constructor-07.adoc[`Formatter&lowbar;State`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/balxml/Formatter_State/2destructor.adoc[`&#126;Formatter&lowbar;State`] [.small]#[destructor]#
| Destroy this object&period;
| xref:BloombergLP/balxml/Formatter_State/operator_assign.adoc[`operator&equals;`] 
| Assign to this object the value of the specified `rhs` and return a reference to this object&period;
| xref:BloombergLP/balxml/Formatter_State/get_allocator.adoc[`get&lowbar;allocator`] 
| Return the allocator associated with this object&period;
| xref:BloombergLP/balxml/Formatter_State/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration&lt;Formatter&lowbar;State, UsesBslmaAllocator&gt;`] 
| `Formatter&lowbar;State` uses a `bslma` allocator&period;
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balxml/Formatter_State/d_compact.adoc[`d&lowbar;compact`] [.small]#[variant member]#
| Compact&hyphen;formatter state when `d&lowbar;mode` is `Mode&colon;&colon;e&lowbar;COMPACT`&period;
| xref:BloombergLP/balxml/Formatter_State/d_pretty.adoc[`d&lowbar;pretty`] [.small]#[variant member]#
| Pretty&hyphen;formatter state when `d&lowbar;mode` is `Mode&colon;&colon;e&lowbar;PRETTY`&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balxml/Formatter.adoc[BloombergLP::balxml::Formatter]`
| This class provides a set of XML&hyphen;style formatting utilities that enable transparent indentation and wrapping for users attempting to format data with XML tags and attributes&period; A formatter object is instantiated with a pointer to an output stream or streambuf&period; Users can then use the provided utilities to write element tags, attributes, data in a valid XML sequence into the underlying stream&period;
|===


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