[#BloombergLP-baljsn-JsonFormatter]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baljsn.adoc[baljsn]::JsonFormatter
:relfileprefix: ../../
:mrdocs:

Formatter that assembles a `bdljsn::Json` object via manipulators.

== Synopsis

Declared in `<baljsn_jsonformatter.h>`

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

== Description

This class implements a formatter mechanism that assembles a (potentially complicated) `bdljsn::Json` object according to the invocations of the formatter's manipulators.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baljsn/JsonFormatter/allocator_type.adoc[`allocator_type`] 
| Type of the allocator used to supply memory.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baljsn/JsonFormatter/2constructor.adoc[`JsonFormatter`]         [.small]#[constructor]#
| Create a `JsonFormatter` that modifies the specified `json` object.
| xref:BloombergLP/baljsn/JsonFormatter/addArrayElementSeparator.adoc[`addArrayElementSeparator`] 
| No‐op.
| xref:BloombergLP/baljsn/JsonFormatter/closeArray.adoc[`closeArray`] 
| Indicate that there are no more elements to be added to the current array.
| xref:BloombergLP/baljsn/JsonFormatter/closeMember.adoc[`closeMember`] 
| Indicate that there are no more members to be added to the current object.
| xref:BloombergLP/baljsn/JsonFormatter/closeObject.adoc[`closeObject`] 
| Indicate that there are no more members to be added to the current object.
| xref:BloombergLP/baljsn/JsonFormatter/dumpStack.adoc[`dumpStack`] 
| Print the internal stack of `Status` objects to standard output in lifo order. Each line of output consists of:
| xref:BloombergLP/baljsn/JsonFormatter/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/baljsn/JsonFormatter/nestingDepth.adoc[`nestingDepth`] 
| No‐op. Return 0.
| xref:BloombergLP/baljsn/JsonFormatter/openArray.adoc[`openArray`] 
| Create a new array for subsequently added elements.
| xref:BloombergLP/baljsn/JsonFormatter/openMember.adoc[`openMember`] 
| Create a new object member having the specified `name`.
| xref:BloombergLP/baljsn/JsonFormatter/openObject.adoc[`openObject`] 
| Create a new object (set of name/value pairs also know as "members"). Note subsequently created members will land in this object until `closeObject` is called.
| xref:BloombergLP/baljsn/JsonFormatter/putNullValue.adoc[`putNullValue`] 
| Set the current array element or object value to null.
| xref:BloombergLP/baljsn/JsonFormatter/putValue.adoc[`putValue`] 
| Set the current scalar, array element, or object member to `value`.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/baljsn/JsonFormatter/d_allocator.adoc[`d_allocator`] 
| Allocator used to supply memory.
| xref:BloombergLP/baljsn/JsonFormatter/d_stack.adoc[`d_stack`] 
| The `d_stack` data member.
|===



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