bpf::json::Json::Object class
#include <Base/include/Framework/Json/Json.hpp>

Reference

Represents a Json Object

Public types

using Iterator = collection::Map<String, Json>::Iterator
using ReverseIterator = collection::Map<String, Json>::ReverseIterator
using CIterator = collection::Map<String, Json>::CIterator
using CReverseIterator = collection::Map<String, Json>::CReverseIterator

Constructors, destructors, conversion operators

Object()
Object(const std::initializer_list<std::pair<String, Json>>& lst) explicit
Object(const collection::Map<String, Json>& map) explicit
Object(collection::Map<String, Json>&& map) explicit

Public functions

auto operator[](const String& name) -> Json&
auto operator[](const String& name) const -> const Json&
void Add(const String& name, const Json& json)
void Add(const String& name, Json&& json)
void RemoveAt(const String& name)
auto Size() const -> fsize noexcept
auto begin() const -> CIterator
auto end() const -> CIterator
auto begin() -> Iterator
auto end() -> Iterator
auto rbegin() const -> CReverseIterator
auto rend() const -> CReverseIterator
auto rbegin() -> ReverseIterator
auto rend() -> ReverseIterator

Public variables

collection::Map<String, Json> Properties

Function documentation

bpf::json::Json::Object::Object()

Constructs an empty object

bpf::json::Json::Object::Object(const std::initializer_list<std::pair<String, Json>>& lst) explicit

Parameters
lst	the initial list of key-value pairs to add to this new Object

Constructs an Object from an existing initializer list

bpf::json::Json::Object::Object(const collection::Map<String, Json>& map) explicit

Parameters
map	the map to construct from

Constructs an Object from an existing Map

bpf::json::Json::Object::Object(collection::Map<String, Json>&& map) explicit

Parameters
map	the map to construct from

Constructs an Object from an existing Map

Json& bpf::json::Json::Object::operator[](const String& name)

Parameters
name	the property name
Returns	mutable item
Exceptions
IndexException	if key is not in this map

Returns an element non-const mode

const Json& bpf::json::Json::Object::operator[](const String& name) const

Parameters
name	the property name
Returns	immutable item
Exceptions
IndexException	if key is not in this map

Returns an element const mode

void bpf::json::Json::Object::Add(const String& name, const Json& json)

Parameters
name	the property name
json	the value to insert

Adds a new property in this object, replaces if the property already exists

void bpf::json::Json::Object::Add(const String& name, Json&& json)

Parameters
name	the property name
json	the value to insert

Adds a new property in this object, replaces if the property already exists

void bpf::json::Json::Object::RemoveAt(const String& name)

Parameters
name	the property name

Removes a property from this object

fsize bpf::json::Json::Object::Size() const noexcept

Returns	number of properties as unsigned

Returns the number of properties in this object

CIterator bpf::json::Json::Object::begin() const

Returns	new iterator

Returns an iterator to the begining of the collection

CIterator bpf::json::Json::Object::end() const

Returns	new iterator

Returns an iterator to the end of the collection

Iterator bpf::json::Json::Object::begin()

Returns	new iterator