[#BloombergLP-bdljsn-JsonArray]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::JsonArray
:relfileprefix: ../../
:mrdocs:

JSON array value providing a sequence‐container‐like interface.

== Synopsis

Declared in `<bdljsn_json.h>`

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

== Description

This type is designed to replicate much of the standard sequence container interface, eliding interfaces that are less relevant for a non‐generic container. Note that a `bsl::vector` is chosen for the implementation because our implementation permits the element type to be incomplete (when just spelling the type name).

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/JsonArray/ConstIterator.adoc[`ConstIterator`] 
| Iterator providing non‐modifiable access to elements.
| xref:BloombergLP/bdljsn/JsonArray/Iterator-0d.adoc[`Iterator`] 
| Iterator providing modifiable access to elements.
| xref:BloombergLP/bdljsn/JsonArray/const_iterator.adoc[`const_iterator`] 
| Iterator providing non‐modifiable access to elements.
| xref:BloombergLP/bdljsn/JsonArray/const_reference.adoc[`const_reference`] 
| Reference providing non‐modifiable access to an element.
| xref:BloombergLP/bdljsn/JsonArray/difference_type.adoc[`difference_type`] 
| Signed type used to represent distances between iterators.
| xref:BloombergLP/bdljsn/JsonArray/iterator-05.adoc[`iterator`] 
| Iterator providing modifiable access to elements.
| xref:BloombergLP/bdljsn/JsonArray/reference.adoc[`reference`] 
| Reference providing modifiable access to an element.
| xref:BloombergLP/bdljsn/JsonArray/size_type.adoc[`size_type`] 
| Unsigned type used to represent sizes and indices.
| xref:BloombergLP/bdljsn/JsonArray/value_type.adoc[`value_type`] 
| Type of the elements stored in this array.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/JsonArray/2constructor-0e.adoc[`JsonArray`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdljsn/JsonArray/operator_assign-04.adoc[`operator=`] 
| Assignment operators
| xref:BloombergLP/bdljsn/JsonArray/allocator.adoc[`allocator`] 
| Return the allocator used by this object to allocate memory.
| xref:BloombergLP/bdljsn/JsonArray/assign-02.adoc[`assign`] 
| `assign` overloads
| xref:BloombergLP/bdljsn/JsonArray/back-068.adoc[`back`] 
| `back` overloads
| xref:BloombergLP/bdljsn/JsonArray/begin-0e.adoc[`begin`] 
| `begin` overloads
| xref:BloombergLP/bdljsn/JsonArray/cbegin.adoc[`cbegin`] 
| Return a const iterator to the first member of this object.
| xref:BloombergLP/bdljsn/JsonArray/cend.adoc[`cend`] 
| Return the past‐the‐end iterator providing non‐modifiable access to this `JsonArray`.
| xref:BloombergLP/bdljsn/JsonArray/clear.adoc[`clear`] 
| Remove all elements from this array.
| xref:BloombergLP/bdljsn/JsonArray/empty.adoc[`empty`] 
| Return `true` if this `JsonArray` has size 0, and `false` otherwise.
| xref:BloombergLP/bdljsn/JsonArray/end-01.adoc[`end`] 
| `end` overloads
| xref:BloombergLP/bdljsn/JsonArray/erase-0b.adoc[`erase`] 
| `erase` overloads
| xref:BloombergLP/bdljsn/JsonArray/front-01.adoc[`front`] 
| `front` overloads
| xref:BloombergLP/bdljsn/JsonArray/insert-0e4.adoc[`insert`] 
| `insert` overloads
| xref:BloombergLP/bdljsn/JsonArray/maxSize.adoc[`maxSize`] 
| Return a theoretical upper bound on this array's maximum size.
| xref:BloombergLP/bdljsn/JsonArray/operator_subs-0b.adoc[`operator[]`] 
| Subscript operators
| xref:BloombergLP/bdljsn/JsonArray/popBack.adoc[`popBack`] 
| Erase the last element from this `JsonArray`. The behavior is undefined if this `JsonArray` is empty.
| xref:BloombergLP/bdljsn/JsonArray/print.adoc[`print`] 
| Write this value to the specified output stream in a human‐readable format.
| xref:BloombergLP/bdljsn/JsonArray/pushBack-0b8.adoc[`pushBack`] 
| `pushBack` overloads
| xref:BloombergLP/bdljsn/JsonArray/resize-00.adoc[`resize`] 
| `resize` overloads
| xref:BloombergLP/bdljsn/JsonArray/size.adoc[`size`] 
| Return the number of elements in this `JsonArray`.
| xref:BloombergLP/bdljsn/JsonArray/swap.adoc[`swap`] 
| Exchange the value of this object with that of `other`.
| xref:BloombergLP/bdljsn/JsonArray/2conversion.adoc[`operator BloombergLP::bslmf::NestedTraitDeclaration<JsonArray, HasPrintMethod>`] 
| Declare that this type uses a `bslma` allocator.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdljsn/swap-02.adoc[BloombergLP::bdljsn::swap]`
| Exchange the values of the specified `a` and `b` arrays.
| `xref:BloombergLP/bdljsn/operator_not_eq-01ca.adoc[BloombergLP::bdljsn::operator!=]`
| Return whether `lhs` and `rhs` do not have the same value.
| `xref:BloombergLP/bdljsn/operator_eq-061.adoc[BloombergLP::bdljsn::operator==]`
| Return whether `lhs` and `rhs` have the same value.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/operator_not_eq-01d.adoc[`operator!=`]
| Return whether `lhs` and `rhs` do not have the same value.
| xref:BloombergLP/bdljsn/operator_eq-0dd1.adoc[`operator==`]
| Return whether `lhs` and `rhs` have the same value.
|===


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