keyring_common::json_data::Json_writer Class Reference

#include <json_writer.h>

Public Member Functions
	Json_writer (const std::string &data={}, const std::string &version="1.0", const std::string &version_key="version", const std::string &array_key="elements")
	Constructor. More...
virtual	~Json_writer ()=default
	Destructor. More...
bool	set_data (const std::string &data)
std::string	to_string () const
	Get string representation of the JSON document. More...
virtual bool	add_element (const meta::Metadata &metadata, const data::Data &data, Json_data_extension &)
	Add an element. More...
virtual bool	remove_element (const meta::Metadata &metadata, const Json_data_extension &)
	Remove an element. More...
size_t	num_elements () const
	Number of elements stored. More...
bool	valid () const
	Validity of the document. More...

Protected Member Functions
virtual bool	set_property (const std::string &property_key, const std::string &property)
	Set a property in the main JSON object. More...

Private Attributes
rapidjson::Document	document_
	Data in JSON DOM format. More...
const std::string	version_key_
	Version information. More...
const std::string	array_key_
	Elements array name. More...
bool	valid_
	Document validity. More...

Constructor & Destructor Documentation

Json_writer()

keyring_common::json_data::Json_writer::Json_writer	(	const std::string &	data = {},
		const std::string &	version = "1.0",
		const std::string &	version_key = "version",
		const std::string &	array_key = "elements"
	)

Constructor.

Parameters

[in]	data	JSON data
[in]	version	Version information
[in]	version_key	Writer version key
[in]	array_key	Key to array that stores all elements

~Json_writer()

virtual keyring_common::json_data::Json_writer::~Json_writer ( )

virtualdefault

Destructor.

Member Function Documentation

add_element()

bool keyring_common::json_data::Json_writer::add_element ( const meta::Metadata &  metadata, const data::Data &  data, Json_data_extension &    )

virtual

Add an element.

Parameters

[in]	metadata	Data identifier
[in]	data	Data

Returns

status of insertion

Return values

false	Success
true	Failure

num_elements()

size_t keyring_common::json_data::Json_writer::num_elements

(

)

const

Number of elements stored.

Get number of elements in the document.

Returns

number elements in the document

remove_element()

bool keyring_common::json_data::Json_writer::remove_element ( const meta::Metadata &  metadata, const Json_data_extension &    )

virtual

Remove an element.

Parameters

[in]

metadata

Data identifier

Returns

status of removal

Return values

false	Success
true	Failure

set_data()

bool keyring_common::json_data::Json_writer::set_data

(

const std::string &

data

)

set_property()

bool keyring_common::json_data::Json_writer::set_property ( const std::string &  property_key, const std::string &  property  )

protectedvirtual

Set a property in the main JSON object.

It is intended to be used by derived classes, so it is possible to store some specific, data file-wide properties.

Parameters

[in]	property_key	key (name) of the property
[in]	property	value of the property

Returns

status

Return values

false	Success
true	Failure

to_string()

std::string keyring_common::json_data::Json_writer::to_string

(

)

const

Get string representation of the JSON document.

valid()

bool keyring_common::json_data::Json_writer::valid ( ) const

inline

Validity of the document.

Member Data Documentation

array_key_

const std::string keyring_common::json_data::Json_writer::array_key_

private

Elements array name.

document_

rapidjson::Document keyring_common::json_data::Json_writer::document_

private

Data in JSON DOM format.

valid_

bool keyring_common::json_data::Json_writer::valid_

private

Document validity.

version_key_

const std::string keyring_common::json_data::Json_writer::version_key_

private

Version information.

---

The documentation for this class was generated from the following files:

• components/keyrings/common/json_data/json_writer.h
• components/keyrings/common/json_data/json_writer.cc