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

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

== Synopsis

Declared in `<bdld_datummapowningkeysbuilder.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/SizeType.adoc[`SizeType`] 
| `SizeType` is an alias for a signed value, representing the capacity, _keys‐capacity_, size or _keys‐size_ of a datum‐key‐owning map.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this builder.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/2constructor-04.adoc[`DatumMapOwningKeysBuilder`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/2destructor.adoc[`~DatumMapOwningKeysBuilder`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/allocator.adoc[`allocator`] 
| Return `get_allocator().mechanism()`.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/append.adoc[`append`] 
| Append the specified array `entries` having the specified `size`.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/capacity.adoc[`capacity`] 
| Return the capacity of the held `Datum` map (owning keys).
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/commit.adoc[`commit`] 
| Return a `Datum` map (owning keys) of the appended elements.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this object to supply memory.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/keysCapacity.adoc[`keysCapacity`] 
| Return the keys‐capacity of the held `Datum` map (owning keys).
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/pushBack.adoc[`pushBack`] 
| Append the entry with the specified `key` and `value`.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/setSorted.adoc[`setSorted`] 
| Mark the map being built as sorted according to the specified `value`.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/size.adoc[`size`] 
| Return the size of the held `Datum` map (owning keys). The behavior is undefined if `commit` or `sortAndCommit` has already been called on this object.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/sortAndCommit.adoc[`sortAndCommit`] 
| Return a key‐sorted `Datum` map (owning keys) of the appended elements.
| xref:BloombergLP/bdld/DatumMapOwningKeysBuilder/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<DatumMapOwningKeysBuilder, UsesBslmaAllocator>`] 
| `DatumMapOwningKeysBuilder` is allocator‐aware.
|===



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