[#BloombergLP-bdld-DatumMapBuilder]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdld.adoc[bdld]::DatumMapBuilder
:relfileprefix: ../../
:mrdocs:

This `class` provides a mechanism to build a `Datum` object having a map value in an exception‐safe manner.

== Synopsis

Declared in `<bdld_datummapbuilder.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumMapBuilder/SizeType.adoc[`SizeType`] 
| `SizeType` is an alias for a unsigned integral value, representing the capacity or size of a datum map.
| xref:BloombergLP/bdld/DatumMapBuilder/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this builder.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumMapBuilder/2constructor-0c.adoc[`DatumMapBuilder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdld/DatumMapBuilder/2destructor.adoc[`~DatumMapBuilder`] [.small]#[destructor]#
| Destroy this object. If this object is holding a datum map that has not been adopted, then the datum map is disposed after destroying each of its elements.
| xref:BloombergLP/bdld/DatumMapBuilder/append.adoc[`append`] 
| Append the specified map entries to this builder.
| xref:BloombergLP/bdld/DatumMapBuilder/capacity.adoc[`capacity`] 
| Return the capacity of the held `Datum` map.
| xref:BloombergLP/bdld/DatumMapBuilder/commit.adoc[`commit`] 
| Return a `Datum` map of the elements supplied so far.
| xref:BloombergLP/bdld/DatumMapBuilder/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/bdld/DatumMapBuilder/pushBack.adoc[`pushBack`] 
| Append an entry with the specified `key` and `value`.
| xref:BloombergLP/bdld/DatumMapBuilder/setSorted.adoc[`setSorted`] 
| Mark the map being built as sorted or unsorted.
| xref:BloombergLP/bdld/DatumMapBuilder/size.adoc[`size`] 
| Return the size of the held `Datum` map. The behavior is undefined if `commit` or `sortAndCommit` has already been called on this object.
| xref:BloombergLP/bdld/DatumMapBuilder/sortAndCommit.adoc[`sortAndCommit`] 
| Return a sorted `Datum` map of the elements supplied so far.
| xref:BloombergLP/bdld/DatumMapBuilder/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<DatumMapBuilder, UsesBslmaAllocator>`] 
| `DatumMapBuilder` is allocator‐aware.
|===



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