Represents a JSON value. More...

#include <json/value.h>

Public Types
typedef std::vector< std::string >	Members

typedef ValueIterator	iterator

typedef ValueConstIterator	const_iterator

typedef Json::UInt	UInt

typedef Json::Int	Int

typedef Json::UInt64	UInt64

typedef Json::Int64	Int64

typedef Json::LargestInt	LargestInt

typedef Json::LargestUInt	LargestUInt

typedef Json::ArrayIndex	ArrayIndex

Public Member Functions
	Value (ValueType type=nullValue)
	Create a default Value of the given type. More...

	Value (Int value)

	Value (UInt value)

	Value (Int64 value)

	Value (UInt64 value)

	Value (double value)

	Value (const char *value)

	Value (const char beginValue, const char endValue)

	Value (const StaticString &value)
	Constructs a value from a static string. More...

	Value (const std::string &value)

	Value (bool value)

	Value (const Value &other)

	~Value ()

Value &	operator= (const Value &other)

void	swap (Value &other)
	Swap values. More...

ValueType	type () const

bool	operator< (const Value &other) const

bool	operator<= (const Value &other) const

bool	operator>= (const Value &other) const

bool	operator> (const Value &other) const

bool	operator== (const Value &other) const

bool	operator!= (const Value &other) const

int	compare (const Value &other) const

const char *	asCString () const

std::string	asString () const

Int	asInt () const

UInt	asUInt () const

Int64	asInt64 () const

UInt64	asUInt64 () const

LargestInt	asLargestInt () const

LargestUInt	asLargestUInt () const

float	asFloat () const

double	asDouble () const

bool	asBool () const

bool	isNull () const

bool	isBool () const

bool	isInt () const

bool	isInt64 () const

bool	isUInt () const

bool	isUInt64 () const

bool	isIntegral () const

bool	isDouble () const

bool	isNumeric () const

bool	isString () const

bool	isArray () const

bool	isObject () const

bool	isConvertibleTo (ValueType other) const

ArrayIndex	size () const
	Number of values in array or object. More...

bool	empty () const
	Return true if empty array, empty object, or null; otherwise, false. More...

bool	operator! () const
	Return isNull() More...

void	clear ()
	Remove all object members and array elements. More...

void	resize (ArrayIndex size)
	Resize the array to size elements. More...

Value &	operator[] (ArrayIndex index)
	Access an array element (zero based index ). More...

Value &	operator[] (int index)
	Access an array element (zero based index ). More...

const Value &	operator[] (ArrayIndex index) const
	Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.) More...

const Value &	operator[] (int index) const
	Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.) More...

Value	get (ArrayIndex index, const Value &defaultValue) const
	If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue. More...

bool	isValidIndex (ArrayIndex index) const
	Return true if index < size(). More...

Value &	append (const Value &value)
	Append value to array at the end. More...

Value &	operator[] (const char *key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const char *key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (const std::string &key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const std::string &key) const
	Access an object value by name, returns null if there is no member with that name. More...

Value &	operator[] (const StaticString &key)
	Access an object value by name, create a null member if it does not exist. More...

Value	get (const char *key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

Value	get (const std::string &key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise. More...

Value	removeMember (const char *key)
	Remove and return the named member. More...

Value	removeMember (const std::string &key)
	Same as removeMember(const char*) More...

bool	isMember (const char *key) const
	Return true if the object has a member named key. More...

bool	isMember (const std::string &key) const
	Return true if the object has a member named key. More...

Members	getMemberNames () const
	Return a list of the member names. More...

void	setComment (const char *comment, CommentPlacement placement)
	Comments must be //... or /* ... *‍/. More...

void	setComment (const std::string &comment, CommentPlacement placement)
	Comments must be //... or /* ... *‍/. More...

bool	hasComment (CommentPlacement placement) const

std::string	getComment (CommentPlacement placement) const
	Include delimiters and embedded newlines. More...

std::string	toStyledString () const

const_iterator	begin () const

const_iterator	end () const

iterator	begin ()

iterator	end ()

void	setOffsetStart (size_t start)

void	setOffsetLimit (size_t limit)

size_t	getOffsetStart () const

size_t	getOffsetLimit () const

Static Public Attributes
static const Value &	null = reinterpret_cast<const Value&>(kNull)

static const LargestInt	minLargestInt = LargestInt(~(LargestUInt(-1) / 2))
	Minimum signed integer value that can be stored in a Json::Value. More...

static const LargestInt	maxLargestInt = LargestInt(LargestUInt(-1) / 2)
	Maximum signed integer value that can be stored in a Json::Value. More...

static const LargestUInt	maxLargestUInt = LargestUInt(-1)
	Maximum unsigned integer value that can be stored in a Json::Value. More...

static const Int	minInt = Int(~(UInt(-1) / 2))
	Minimum signed int value that can be stored in a Json::Value. More...

static const Int	maxInt = Int(UInt(-1) / 2)
	Maximum signed int value that can be stored in a Json::Value. More...

static const UInt	maxUInt = UInt(-1)
	Maximum unsigned int value that can be stored in a Json::Value. More...

static const Int64	minInt64 = Int64(~(UInt64(-1) / 2))
	Minimum signed 64 bits int value that can be stored in a Json::Value. More...

static const Int64	maxInt64 = Int64(UInt64(-1) / 2)
	Maximum signed 64 bits int value that can be stored in a Json::Value. More...

static const UInt64	maxUInt64 = UInt64(-1)
	Maximum unsigned 64 bits int value that can be stored in a Json::Value. More...

Friends
class	ValueIteratorBase

class	ValueInternalLink

class	ValueInternalMap

Detailed Description

Represents a JSON value.

This class is a discriminated union wrapper that can represents a:

signed integer [range: Value::minInt - Value::maxInt]
unsigned integer (range: 0 - Value::maxUInt)
double
UTF-8 string
boolean
'null'
an ordered list of Value
collection of name/value pairs (javascript object)

The type of the held value is represented by a ValueType and can be obtained using type().

values of an objectValue or arrayValue can be accessed using operator[]() methods. Non const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resize and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtanis default value in the case the required element does not exist.

It is possible to iterate over the list of a objectValue values using the getMemberNames() method.

Definition at line 116 of file value.h.

Member Typedef Documentation

◆ ArrayIndex

typedef Json::ArrayIndex Json::Value::ArrayIndex

Definition at line 134 of file value.h.

◆ const_iterator

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 125 of file value.h.

◆ Int

typedef Json::Int Json::Value::Int

Definition at line 127 of file value.h.

◆ Int64

typedef Json::Int64 Json::Value::Int64

Definition at line 130 of file value.h.

◆ iterator

typedef ValueIterator Json::Value::iterator

Definition at line 124 of file value.h.

◆ LargestInt

typedef Json::LargestInt Json::Value::LargestInt

Definition at line 132 of file value.h.

◆ LargestUInt

typedef Json::LargestUInt Json::Value::LargestUInt

Definition at line 133 of file value.h.

◆ Members

typedef std::vector<std::string> Json::Value::Members

Definition at line 123 of file value.h.

◆ UInt

typedef Json::UInt Json::Value::UInt

Definition at line 126 of file value.h.

◆ UInt64

typedef Json::UInt64 Json::Value::UInt64

Definition at line 129 of file value.h.

Constructor & Destructor Documentation

◆ Value() [1/12]

Json::Value::Value ( ValueType type = nullValue )

Create a default Value of the given type.

This is a very useful constructor. To create an empty array, pass arrayValue. To create an empty object, pass objectValue. Another Value can then be set to this one by assignment. This is useful since clear() and resize() will not alter types.

Examples:

Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

Default constructor initialization must be equivalent to: memset( this, 0, sizeof(Value) ) This optimization is used in ValueInternalMap fast allocator.

Definition at line 231 of file json_value.cpp.

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::ValueArrayAllocator::newArray(), Json::ValueMapAllocator::newMap(), Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, type(), and Json::uintValue.

Referenced by operator[](), and resize().

◆ Value() [2/12]

Json::Value::Value ( Int value )

Definition at line 284 of file json_value.cpp.

◆ Value() [3/12]

Json::Value::Value ( UInt value )

Definition at line 273 of file json_value.cpp.

◆ Value() [4/12]

Json::Value::Value ( Int64 value )

Definition at line 296 of file json_value.cpp.

◆ Value() [5/12]

Json::Value::Value ( UInt64 value )

Definition at line 307 of file json_value.cpp.

◆ Value() [6/12]

Json::Value::Value ( double value )

Definition at line 319 of file json_value.cpp.

◆ Value() [7/12]

Json::Value::Value ( const char * value )

Definition at line 330 of file json_value.cpp.

References Json::duplicateStringValue().

◆ Value() [8/12]

Json::Value::Value	(	const char *	beginValue,
		const char *	endValue
	)

Definition at line 341 of file json_value.cpp.

References Json::duplicateStringValue().

◆ Value() [9/12]

Json::Value::Value ( const StaticString & value )

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor. Example of usage:

Json::Value aValue( StaticString("some text") );

Definition at line 365 of file json_value.cpp.

References Json::StaticString::c_str().

◆ Value() [10/12]

Json::Value::Value ( const std::string & value )

Definition at line 353 of file json_value.cpp.

References Json::duplicateStringValue().

◆ Value() [11/12]

Json::Value::Value ( bool value )

Definition at line 389 of file json_value.cpp.

◆ Value() [12/12]

Json::Value::Value ( const Value & other )

Definition at line 400 of file json_value.cpp.

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::duplicateStringValue(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::ValueArrayAllocator::newArrayCopy(), Json::ValueMapAllocator::newMapCopy(), Json::nullValue, Json::numberOfCommentPlacement, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

◆ ~Value()

Json::Value::~Value ( )

Definition at line 451 of file json_value.cpp.

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::ValueArrayAllocator::destructArray(), Json::ValueMapAllocator::destructMap(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::nullValue, Json::objectValue, Json::realValue, Json::releaseStringValue(), Json::stringValue, and Json::uintValue.

Referenced by Json::ValueInternalArray::resize(), and Json::ValueInternalArray::~ValueInternalArray().

Member Function Documentation

◆ append()

Value & Json::Value::append ( const Value & value )

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

Definition at line 1042 of file json_value.cpp.

References size().

◆ asBool()

bool Json::Value::asBool ( ) const

Definition at line 779 of file json_value.cpp.

References Json::booleanValue, Json::intValue, JSON_FAIL_MESSAGE, Json::nullValue, Json::realValue, and Json::uintValue.

◆ asCString()

const char * Json::Value::asCString ( ) const

Definition at line 599 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, and Json::stringValue.

◆ asDouble()

double Json::Value::asDouble ( ) const

Definition at line 735 of file json_value.cpp.

References Json::booleanValue, Json::intValue, JSON_FAIL_MESSAGE, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by isConvertibleTo().

◆ asFloat()

float Json::Value::asFloat ( ) const

Definition at line 757 of file json_value.cpp.

References Json::booleanValue, Json::intValue, JSON_FAIL_MESSAGE, Json::nullValue, Json::realValue, and Json::uintValue.

◆ asInt()

Value::Int Json::Value::asInt ( ) const

Definition at line 630 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isInt(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxInt, minInt, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestInt().

◆ asInt64()

Value::Int64 Json::Value::asInt64 ( ) const

Definition at line 676 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isInt64(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxInt64, minInt64, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestInt().

◆ asLargestInt()

LargestInt Json::Value::asLargestInt ( ) const

Definition at line 719 of file json_value.cpp.

References asInt(), and asInt64().

◆ asLargestUInt()

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 727 of file json_value.cpp.

References asUInt(), and asUInt64().

◆ asString()

std::string Json::Value::asString ( ) const

Definition at line 605 of file json_value.cpp.

References Json::booleanValue, Json::intValue, JSON_FAIL_MESSAGE, Json::nullValue, Json::realValue, Json::stringValue, Json::uintValue, and Json::valueToString().

Referenced by isConvertibleTo().

◆ asUInt()

Value::UInt Json::Value::asUInt ( ) const

Definition at line 652 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isUInt(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxUInt, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestUInt().

◆ asUInt64()

Value::UInt64 Json::Value::asUInt64 ( ) const

Definition at line 697 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isUInt64(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxUInt64, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestUInt().

◆ begin() [1/2]

Value::iterator Json::Value::begin ( )

Definition at line 1343 of file json_value.cpp.

References Json::arrayValue, and Json::objectValue.

◆ begin() [2/2]

Value::const_iterator Json::Value::begin ( ) const

Definition at line 1283 of file json_value.cpp.

References Json::arrayValue, and Json::objectValue.

◆ clear()

void Json::Value::clear ( )

Remove all object members and array elements.

Precondition: type() is arrayValue, objectValue, or nullValue

Postcondition: type() is unchanged

Definition at line 870 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

Referenced by resize().

◆ compare()

int Json::Value::compare ( const Value & other ) const

Definition at line 504 of file json_value.cpp.

Referenced by Json::ValueInternalMap::compare(), and Json::ValueInternalArray::compare().

◆ empty()

bool Json::Value::empty ( ) const

Return true if empty array, empty object, or null; otherwise, false.

Definition at line 861 of file json_value.cpp.

References isArray(), isNull(), isObject(), and size().

◆ end() [1/2]

Value::iterator Json::Value::end ( )

Definition at line 1373 of file json_value.cpp.

References Json::arrayValue, and Json::objectValue.

◆ end() [2/2]

Value::const_iterator Json::Value::end ( ) const

Definition at line 1313 of file json_value.cpp.

References Json::arrayValue, and Json::objectValue.

◆ get() [1/3]

Value Json::Value::get	(	ArrayIndex	index,
		const Value &	defaultValue
	)		const

If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.

Definition at line 995 of file json_value.cpp.

Referenced by get().

◆ get() [2/3]

Value Json::Value::get	(	const char *	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 1044 of file json_value.cpp.

◆ get() [3/3]

Value Json::Value::get	(	const std::string &	key,
		const Value &	defaultValue
	)		const

Return the member named key if it exist, defaultValue otherwise.

Definition at line 1049 of file json_value.cpp.

References get().

◆ getComment()

std::string Json::Value::getComment ( CommentPlacement placement ) const

Include delimiters and embedded newlines.

Definition at line 1264 of file json_value.cpp.

References hasComment().

◆ getMemberNames()

Value::Members Json::Value::getMemberNames ( ) const

Return a list of the member names.

If null, return an empty list.

Precondition: type() is objectValue or nullValue

Postcondition: if type() was nullValue, it remains nullValue

Definition at line 1104 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

◆ getOffsetLimit()

size_t Json::Value::getOffsetLimit ( ) const

Definition at line 1276 of file json_value.cpp.

◆ getOffsetStart()

size_t Json::Value::getOffsetStart ( ) const

Definition at line 1274 of file json_value.cpp.

◆ hasComment()

bool Json::Value::hasComment ( CommentPlacement placement ) const

Definition at line 1260 of file json_value.cpp.

Referenced by getComment().

◆ isArray()

bool Json::Value::isArray ( ) const

Definition at line 1246 of file json_value.cpp.

References Json::arrayValue.

Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

◆ isBool()

bool Json::Value::isBool ( ) const

Definition at line 1160 of file json_value.cpp.

References Json::booleanValue.

◆ isConvertibleTo()

bool Json::Value::isConvertibleTo ( ValueType other ) const

Definition at line 797 of file json_value.cpp.

References Json::arrayValue, asDouble(), asString(), Json::booleanValue, Json::InRange(), Json::intValue, isInt(), isNumeric(), isUInt(), JSON_ASSERT_UNREACHABLE, maxInt, maxUInt, minInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

◆ isDouble()

bool Json::Value::isDouble ( ) const

Definition at line 1240 of file json_value.cpp.

References isIntegral(), and Json::realValue.

Referenced by isNumeric().

◆ isInt()

bool Json::Value::isInt ( ) const

Definition at line 1162 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxInt, minInt, Json::realValue, and Json::uintValue.

Referenced by asInt(), isConvertibleTo(), and isIntegral().

◆ isInt64()

bool Json::Value::isInt64 ( ) const

Definition at line 1192 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxInt64, minInt64, Json::realValue, and Json::uintValue.

Referenced by asInt64(), and isIntegral().

◆ isIntegral()

bool Json::Value::isIntegral ( ) const

Definition at line 1232 of file json_value.cpp.

References isInt(), isInt64(), isUInt(), and isUInt64().

Referenced by isDouble(), and isNumeric().

◆ isMember() [1/2]

bool Json::Value::isMember ( const char * key ) const

Return true if the object has a member named key.

Definition at line 1089 of file json_value.cpp.

Referenced by isMember().

◆ isMember() [2/2]

bool Json::Value::isMember ( const std::string & key ) const

Return true if the object has a member named key.

Definition at line 1094 of file json_value.cpp.

References isMember().

◆ isNull()

bool Json::Value::isNull ( ) const

Definition at line 1158 of file json_value.cpp.

References Json::nullValue.

Referenced by empty(), and operator!().

◆ isNumeric()

bool Json::Value::isNumeric ( ) const

Definition at line 1242 of file json_value.cpp.

References isDouble(), and isIntegral().

Referenced by isConvertibleTo().

◆ isObject()

bool Json::Value::isObject ( ) const

Definition at line 1248 of file json_value.cpp.

References Json::objectValue.

Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

◆ isString()

bool Json::Value::isString ( ) const

Definition at line 1244 of file json_value.cpp.

References Json::stringValue.

◆ isUInt()

bool Json::Value::isUInt ( ) const

Definition at line 1177 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxUInt, Json::realValue, and Json::uintValue.

Referenced by asUInt(), isConvertibleTo(), and isIntegral().

◆ isUInt64()

bool Json::Value::isUInt64 ( ) const

Definition at line 1212 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::maxUInt64AsDouble, Json::realValue, and Json::uintValue.

Referenced by asUInt64(), and isIntegral().

◆ isValidIndex()

bool Json::Value::isValidIndex ( ArrayIndex index ) const

Return true if index < size().

Definition at line 1000 of file json_value.cpp.

References size().

Referenced by Json::Path::resolve().

◆ operator!()

bool Json::Value::operator! ( ) const

Return isNull()

Definition at line 868 of file json_value.cpp.

References isNull().

◆ operator!=()

bool Json::Value::operator!= ( const Value & other ) const

Definition at line 597 of file json_value.cpp.

◆ operator<()

bool Json::Value::operator< ( const Value & other ) const

Definition at line 512 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

◆ operator<=()

bool Json::Value::operator<= ( const Value & other ) const

Definition at line 551 of file json_value.cpp.

◆ operator=()

Value & Json::Value::operator= ( const Value & other )

Definition at line 484 of file json_value.cpp.

References swap().

◆ operator==()

bool Json::Value::operator== ( const Value & other ) const

Definition at line 557 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

◆ operator>()

bool Json::Value::operator> ( const Value & other ) const

Definition at line 555 of file json_value.cpp.

◆ operator>=()

bool Json::Value::operator>= ( const Value & other ) const

Definition at line 553 of file json_value.cpp.

◆ operator[]() [1/9]

Value & Json::Value::operator[] ( ArrayIndex index )

Access an array element (zero based index ).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 917 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, Json::nullValue, and Value().

◆ operator[]() [2/9]

const Value & Json::Value::operator[] ( ArrayIndex index ) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 944 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, and Json::nullValue.

◆ operator[]() [3/9]

Value & Json::Value::operator[] ( const char * key )

Access an object value by name, create a null member if it does not exist.

Definition at line 969 of file json_value.cpp.

◆ operator[]() [4/9]

const Value & Json::Value::operator[] ( const char * key ) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 1002 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

◆ operator[]() [5/9]

Value & Json::Value::operator[] ( const StaticString & key )

Access an object value by name, create a null member if it does not exist.

If the object as no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

Json::Value object;
static const StaticString code("code");
object[code] = 1234;

Definition at line 1028 of file json_value.cpp.

◆ operator[]() [6/9]

Value & Json::Value::operator[] ( const std::string & key )

Access an object value by name, create a null member if it does not exist.

Definition at line 1020 of file json_value.cpp.

◆ operator[]() [7/9]

const Value & Json::Value::operator[] ( const std::string & key ) const

Access an object value by name, returns null if there is no member with that name.

Definition at line 1024 of file json_value.cpp.

◆ operator[]() [8/9]

Value & Json::Value::operator[] ( int index )

Access an array element (zero based index ).

If the array contains less than index element, then null value are inserted in the array so that its size is index+1. (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 937 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

◆ operator[]() [9/9]

const Value & Json::Value::operator[] ( int index ) const

Access an array element (zero based index ) (You may need to say 'value[0u]' to get your compiler to distinguish this from the operator[] which takes a string.)

Definition at line 962 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

◆ removeMember() [1/2]

Value Json::Value::removeMember ( const char * key )

Remove and return the named member.

Do nothing if it did not exist.

Returns: the removed Value, or null.

Precondition: type() is objectValue or nullValue

Postcondition: type() is unchanged

Definition at line 1053 of file json_value.cpp.

References JSON_ASSERT_MESSAGE, Json::nullValue, and Json::objectValue.

Referenced by removeMember().

◆ removeMember() [2/2]

Value Json::Value::removeMember ( const std::string & key )

Same as removeMember(const char*)

Definition at line 1078 of file json_value.cpp.

References removeMember().

◆ resize()

void Json::Value::resize ( ArrayIndex size )

Resize the array to size elements.

New elements are initialized to null. May only be called on nullValue or arrayValue.

Precondition: type() is arrayValue or nullValue

Postcondition: type() is arrayValue

Definition at line 895 of file json_value.cpp.

References Json::arrayValue, clear(), JSON_ASSERT_MESSAGE, Json::nullValue, size(), and Value().

◆ setComment() [1/2]

void Json::Value::setComment	(	const char *	comment,
		CommentPlacement	placement
	)

Comments must be //... or /* ... *‍/.

Definition at line 1250 of file json_value.cpp.

References Json::numberOfCommentPlacement.

Referenced by Json::Reader::parse(), and setComment().

◆ setComment() [2/2]

void Json::Value::setComment	(	const std::string &	comment,
		CommentPlacement	placement
	)

Comments must be //... or /* ... *‍/.

Definition at line 1256 of file json_value.cpp.

References setComment().

◆ setOffsetLimit()

void Json::Value::setOffsetLimit ( size_t limit )

Definition at line 1272 of file json_value.cpp.

◆ setOffsetStart()

void Json::Value::setOffsetStart ( size_t start )

Definition at line 1270 of file json_value.cpp.

◆ size()

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

Definition at line 831 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by append(), empty(), isValidIndex(), and resize().

◆ swap()

void Json::Value::swap ( Value & other )

Swap values.

Note: Currently, comments are intentionally not swapped, for both logic and efficiency.

Definition at line 490 of file json_value.cpp.

Referenced by Json::ValueInternalMap::doActualRemove(), and operator=().

◆ toStyledString()

std::string Json::Value::toStyledString ( ) const

Definition at line 1278 of file json_value.cpp.

References Json::StyledWriter::write().

◆ type()

ValueType Json::Value::type ( ) const

Definition at line 502 of file json_value.cpp.

Referenced by Value().

Friends And Related Function Documentation

◆ ValueInternalLink

friend class ValueInternalLink

friend

Definition at line 119 of file value.h.

◆ ValueInternalMap

friend class ValueInternalMap

friend

Definition at line 120 of file value.h.

◆ ValueIteratorBase

friend class ValueIteratorBase

friend

Definition at line 117 of file value.h.

Member Data Documentation

◆ maxInt

const Int Json::Value::maxInt = Int(UInt(-1) / 2)

static

Maximum signed int value that can be stored in a Json::Value.

Definition at line 147 of file value.h.

Referenced by asInt(), Json::duplicateStringValue(), isConvertibleTo(), and isInt().

◆ maxInt64

const Int64 Json::Value::maxInt64 = Int64(UInt64(-1) / 2)

static

Maximum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 155 of file value.h.

Referenced by asInt64(), and isInt64().

◆ maxLargestInt

const LargestInt Json::Value::maxLargestInt = LargestInt(LargestUInt(-1) / 2)

static

Maximum signed integer value that can be stored in a Json::Value.

Definition at line 140 of file value.h.

◆ maxLargestUInt

const LargestUInt Json::Value::maxLargestUInt = LargestUInt(-1)

static

Maximum unsigned integer value that can be stored in a Json::Value.

Definition at line 142 of file value.h.

◆ maxUInt

const UInt Json::Value::maxUInt = UInt(-1)

static

Maximum unsigned int value that can be stored in a Json::Value.

Definition at line 149 of file value.h.

Referenced by asUInt(), isConvertibleTo(), and isUInt().

◆ maxUInt64

const UInt64 Json::Value::maxUInt64 = UInt64(-1)

static

Maximum unsigned 64 bits int value that can be stored in a Json::Value.

Definition at line 157 of file value.h.

Referenced by asUInt64().

◆ minInt

const Int Json::Value::minInt = Int(~(UInt(-1) / 2))

static

Minimum signed int value that can be stored in a Json::Value.

Definition at line 145 of file value.h.

Referenced by asInt(), isConvertibleTo(), and isInt().

◆ minInt64

const Int64 Json::Value::minInt64 = Int64(~(UInt64(-1) / 2))

static

Minimum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 153 of file value.h.

Referenced by asInt64(), and isInt64().

◆ minLargestInt

const LargestInt Json::Value::minLargestInt = LargestInt(~(LargestUInt(-1) / 2))

static

Minimum signed integer value that can be stored in a Json::Value.

Definition at line 138 of file value.h.

◆ null

const Value & Json::Value::null = reinterpret_cast<const Value&>(kNull)

static

Definition at line 136 of file value.h.

Referenced by Json::Path::resolve().

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

include/json/value.h
src/lib_json/json_value.cpp

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ArrayIndex

◆ const_iterator

◆ Int

◆ Int64

◆ iterator

◆ LargestInt

◆ LargestUInt

◆ Members

◆ UInt

◆ UInt64

Constructor & Destructor Documentation

◆ Value() [1/12]

◆ Value() [2/12]

◆ Value() [3/12]

◆ Value() [4/12]

◆ Value() [5/12]

◆ Value() [6/12]

◆ Value() [7/12]

◆ Value() [8/12]

◆ Value() [9/12]

◆ Value() [10/12]

◆ Value() [11/12]

◆ Value() [12/12]

◆ ~Value()

Member Function Documentation

◆ append()

◆ asBool()

◆ asCString()

◆ asDouble()

◆ asFloat()

◆ asInt()

◆ asInt64()

◆ asLargestInt()

◆ asLargestUInt()

◆ asString()

◆ asUInt()

◆ asUInt64()

◆ begin() [1/2]

◆ begin() [2/2]

◆ clear()

◆ compare()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getComment()

◆ getMemberNames()

◆ getOffsetLimit()

◆ getOffsetStart()

◆ hasComment()

◆ isArray()

◆ isBool()

◆ isConvertibleTo()

◆ isDouble()

◆ isInt()

◆ isInt64()

◆ isIntegral()

◆ isMember() [1/2]

◆ isMember() [2/2]

◆ isNull()

◆ isNumeric()

◆ isObject()

◆ isString()

◆ isUInt()

◆ isUInt64()

◆ isValidIndex()

◆ operator!()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()