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)
	Copy til first 0. (NULL causes to seg-fault.) More...

	Value (const char begin, const char end)
	Copy all, incl zeroes. More...

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

	Value (const std::string &value)
	Copy data() til size(). Embedded zeroes too. More...

	Value (bool value)

	Value (const Value &other)
	Deep copy. More...

	~Value ()

Value &	operator= (const Value &other)
	Deep copy, then swap(other). More...

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

void	swapPayload (Value &other)
	Swap values but leave comments and source offsets in place. More...

ValueType	type () const

bool	operator< (const Value &other) const
	Compare payload only, not comments etc. More...

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
	Embedded zeroes could cause you trouble! More...

std::string	asString () const
	Embedded zeroes are possible. More...

bool	getString (char const begin, char const end) const
	Get raw char* of string-value. More...

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 char begin, const char end, 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 const *	find (char const begin, char const end) const
	Most general and efficient version of isMember()const, get()const, and operator[]const. More...

Value const *	demand (char const begin, char const end)
	Most general and efficient version of object-mutators. 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	removeMember (const char key, Value removed)
	Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated. More...

bool	removeMember (std::string const &key, Value *removed)
	Remove the named map member. More...

bool	removeMember (const char begin, const char end, Value *removed)
	Same as removeMember(std::string const& key, Value* removed) More...

bool	removeIndex (ArrayIndex i, Value *removed)
	Remove the indexed array element. 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...

bool	isMember (const char begin, const char end) const
	Same as isMember(std::string const& key)const. More...

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

void	setComment (const char *comment, CommentPlacement placement)

void	setComment (const char *comment, size_t len, 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 ()

Static Public Attributes
static const Value &	nullRef = reinterpret_cast<const Value&>(kNullRef)

static const Value	null

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

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 resized and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtain 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.

Note: Value string-length fit in size_t, but keys must be < 2^30. (The reason is an implementation detail.) A #CharReader will raise an exception if a bound is exceeded to avoid security holes in your app, but the Value API does not check bounds. That is the responsibility of the caller.

Definition at line 162 of file value.h.

Member Typedef Documentation

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

Definition at line 176 of file value.h.

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 167 of file value.h.

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

Definition at line 169 of file value.h.

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

Definition at line 172 of file value.h.

typedef ValueIterator Json::Value::iterator

Definition at line 166 of file value.h.

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

Definition at line 174 of file value.h.

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

Definition at line 175 of file value.h.

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

Definition at line 165 of file value.h.

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

Definition at line 168 of file value.h.

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

Definition at line 171 of file value.h.

Constructor & Destructor Documentation

Json::Value::Value ( ValueType vtype = 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 299 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 operator[](), and resize().

Json::Value::Value ( Int value )

Definition at line 326 of file json_value.cpp.

References Json::intValue.

Json::Value::Value ( UInt value )

Definition at line 331 of file json_value.cpp.

References Json::uintValue.

Json::Value::Value ( Int64 value )

Definition at line 336 of file json_value.cpp.

References Json::intValue.

Json::Value::Value ( UInt64 value )

Definition at line 340 of file json_value.cpp.

References Json::uintValue.

Json::Value::Value ( double value )

Definition at line 346 of file json_value.cpp.

References Json::realValue.

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

Copy til first 0. (NULL causes to seg-fault.)

Definition at line 351 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

Json::Value::Value	(	const char *	begin,
		const char *	end
	)

Copy all, incl zeroes.

Definition at line 356 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

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.

Note: This works only for null-terminated strings. (We cannot change the size of this class, so we have nowhere to store the length, which might be computed later for various operations.)

Example of usage:

static StaticString foo("some text");

Json::Value aValue(foo);

Definition at line 368 of file json_value.cpp.

References Json::StaticString::c_str(), and Json::stringValue.

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

Copy data() til size(). Embedded zeroes too.

Definition at line 362 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

Json::Value::Value ( bool value )

Definition at line 380 of file json_value.cpp.

References Json::booleanValue.

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

Deep copy.

Definition at line 385 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::decodePrefixedString(), Json::duplicateAndPrefixStringValue(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::nullValue, Json::numberOfCommentPlacement, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Json::Value::~Value ( )

Definition at line 429 of file json_value.cpp.

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

Member Function Documentation

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

Append value to array at the end.

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

Definition at line 1047 of file json_value.cpp.

References size().

bool Json::Value::asBool ( ) const

Definition at line 785 of file json_value.cpp.

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

Referenced by Json::CharReaderBuilder::newCharReader().

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

Embedded zeroes could cause you trouble!

Definition at line 582 of file json_value.cpp.

References Json::decodePrefixedString(), JSON_ASSERT_MESSAGE, and Json::stringValue.

double Json::Value::asDouble ( ) const

Definition at line 741 of file json_value.cpp.

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

Referenced by isConvertibleTo().

float Json::Value::asFloat ( ) const

Definition at line 763 of file json_value.cpp.

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

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

Definition at line 636 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(), and Json::CharReaderBuilder::newCharReader().

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

Definition at line 682 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().

LargestInt Json::Value::asLargestInt ( ) const

Definition at line 725 of file json_value.cpp.

References asInt(), and asInt64().

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 733 of file json_value.cpp.

References asUInt(), and asUInt64().

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

Embedded zeroes are possible.

Definition at line 601 of file json_value.cpp.

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

Referenced by isConvertibleTo().

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

Definition at line 658 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().

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

Definition at line 703 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().

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

Definition at line 1323 of file json_value.cpp.

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

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

Definition at line 1349 of file json_value.cpp.

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

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().

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

Definition at line 476 of file json_value.cpp.

Value const* Json::Value::demand	(	char const *	begin,
		char const *	end
	)

Most general and efficient version of object-mutators.

Note: As stated elsewhere, behavior is undefined if (end-begin) >= 2^30

Returns: non-zero, but JSON_ASSERT if this is neither object nor nullValue.

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().

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

Definition at line 1336 of file json_value.cpp.

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

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

Definition at line 1362 of file json_value.cpp.

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

Value const * Json::Value::find	(	char const *	begin,
		char const *	end
	)		const

Most general and efficient version of isMember()const, get()const, and operator[]const.

Note: As stated elsewhere, behavior is undefined if (end-begin) >= 2^30

Definition at line 999 of file json_value.cpp.

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

Referenced by get(), isMember(), and operator[]().

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 992 of file json_value.cpp.

References nullRef.

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

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

Note: deep copy

Definition at line 1054 of file json_value.cpp.

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

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

Note: deep copy; key may contain embedded nulls.

Definition at line 1049 of file json_value.cpp.

References find().

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

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

Note: deep copy

Parameters

key	may contain embedded nulls.

Definition at line 1058 of file json_value.cpp.

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

Include delimiters and embedded newlines.

Definition at line 1312 of file json_value.cpp.

References hasComment().

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 1151 of file json_value.cpp.

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

Referenced by Json::CharReaderBuilder::validate().

bool Json::Value::getString	(	char const **	begin,
		char const **	end
	)		const

Get raw char* of string-value.

Returns: false if !string. (Seg-fault if str or end are NULL.)

Definition at line 592 of file json_value.cpp.

References Json::decodePrefixedString(), and Json::stringValue.

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

Definition at line 1308 of file json_value.cpp.

Referenced by getComment().

bool Json::Value::isArray ( ) const

Definition at line 1286 of file json_value.cpp.

References Json::arrayValue.

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

bool Json::Value::isBool ( ) const

Definition at line 1200 of file json_value.cpp.

References Json::booleanValue.

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

Definition at line 804 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.

bool Json::Value::isDouble ( ) const

Definition at line 1280 of file json_value.cpp.

References isIntegral(), and Json::realValue.

Referenced by isNumeric().

bool Json::Value::isInt ( ) const

Definition at line 1202 of file json_value.cpp.

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

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

bool Json::Value::isInt64 ( ) const

Definition at line 1232 of file json_value.cpp.

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

Referenced by asInt64(), and isIntegral().

bool Json::Value::isIntegral ( ) const

Definition at line 1272 of file json_value.cpp.

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

Referenced by isDouble(), and isNumeric().

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

Return true if the object has a member named key.

Note: 'key' must be null-terminated.

Definition at line 1136 of file json_value.cpp.

Referenced by isMember().

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

Return true if the object has a member named key.

Parameters

key	may contain embedded nulls.

Definition at line 1140 of file json_value.cpp.

References isMember().

bool Json::Value::isMember	(	const char *	begin,
		const char *	end
	)		const

Same as isMember(std::string const& key)const.

Definition at line 1131 of file json_value.cpp.

References find().

bool Json::Value::isNull ( ) const

Definition at line 1198 of file json_value.cpp.

References Json::nullValue.

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

bool Json::Value::isNumeric ( ) const

Definition at line 1282 of file json_value.cpp.

References isDouble(), and isIntegral().

Referenced by isConvertibleTo().

bool Json::Value::isObject ( ) const

Definition at line 1288 of file json_value.cpp.

References Json::objectValue.

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

bool Json::Value::isString ( ) const

Definition at line 1284 of file json_value.cpp.

References Json::stringValue.

bool Json::Value::isUInt ( ) const

Definition at line 1217 of file json_value.cpp.

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

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

bool Json::Value::isUInt64 ( ) const

Definition at line 1252 of file json_value.cpp.

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

Referenced by asUInt64(), and isIntegral().

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

Return true if index < size().

Definition at line 997 of file json_value.cpp.

References size().

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

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

Return isNull()

Definition at line 868 of file json_value.cpp.

References isNull().

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

Definition at line 580 of file json_value.cpp.

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

Compare payload only, not comments etc.

Definition at line 484 of file json_value.cpp.

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

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

Definition at line 530 of file json_value.cpp.

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

Deep copy, then swap(other).

Note: Over-write existing comments. To preserve comments, use swapPayload().

Definition at line 453 of file json_value.cpp.

References swap().

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

Definition at line 536 of file json_value.cpp.

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

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

Definition at line 534 of file json_value.cpp.

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

Definition at line 532 of file json_value.cpp.

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 902 of file json_value.cpp.

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

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 918 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

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 925 of file json_value.cpp.

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

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 938 of file json_value.cpp.

References JSON_ASSERT_MESSAGE.

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

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

Note: Because of our implementation, keys are limited to 2^30 -1 chars. Exceeding that will cause an exception.

Definition at line 1023 of file json_value.cpp.

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 1010 of file json_value.cpp.

References find(), and nullRef.

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

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

Parameters

key	may contain embedded nulls.

Definition at line 1027 of file json_value.cpp.

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

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

Parameters

key	may contain embedded nulls.

Definition at line 1016 of file json_value.cpp.

References find(), and nullRef.

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 has 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 1031 of file json_value.cpp.

References Json::StaticString::c_str().

bool Json::Value::removeIndex	(	ArrayIndex	i,
		Value *	removed
	)

Remove the indexed array element.

O(n) expensive operations. Update 'removed' iff removed.

Returns: true iff removed (no exceptions)

Definition at line 1101 of file json_value.cpp.

References Json::arrayValue, and size().

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

Deprecated:

Definition at line 1085 of file json_value.cpp.

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

Referenced by removeMember().

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

Same as removeMember(const char*)

Parameters

key	may contain embedded nulls.

Deprecated:

Definition at line 1096 of file json_value.cpp.

References removeMember().

bool Json::Value::removeMember	(	const char *	key,
		Value *	removed
	)

Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated.

Definition at line 1077 of file json_value.cpp.

References removeMember().

bool Json::Value::removeMember	(	std::string const &	key,
		Value *	removed
	)

Remove the named map member.

Update 'removed' iff removed.

Parameters

key	may contain embedded nulls.

Returns: true iff removed (no exceptions)

Definition at line 1081 of file json_value.cpp.

References removeMember().

bool Json::Value::removeMember	(	const char *	begin,
		const char *	end,
		Value *	removed
	)

Same as removeMember(std::string const& key, Value* removed)

Definition at line 1064 of file json_value.cpp.

References Json::objectValue.

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 884 of file json_value.cpp.

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

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

Deprecated:: Always pass len.

Definition at line 1300 of file json_value.cpp.

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

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

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

Definition at line 1290 of file json_value.cpp.

References Json::numberOfCommentPlacement.

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

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

Definition at line 1304 of file json_value.cpp.

References setComment().

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

Definition at line 838 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(), removeIndex(), resize(), Json::StreamWriterBuilder::validate(), and Json::CharReaderBuilder::validate().

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

Swap everything.

Definition at line 469 of file json_value.cpp.

References swapPayload().

Referenced by operator=().

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

Swap values but leave comments and source offsets in place.

Definition at line 459 of file json_value.cpp.

Referenced by swap().

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

Definition at line 1318 of file json_value.cpp.

References Json::StyledWriter::write().

ValueType Json::Value::type ( ) const

Definition at line 474 of file json_value.cpp.

Friends And Related Function Documentation

friend class ValueIteratorBase

friend

Definition at line 163 of file value.h.

Member Data Documentation

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 193 of file value.h.

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

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 201 of file value.h.

Referenced by asInt64(), and isInt64().

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 186 of file value.h.

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

static

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

Definition at line 188 of file value.h.

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

static

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

Definition at line 195 of file value.h.

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

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 203 of file value.h.

Referenced by asUInt64().

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 191 of file value.h.

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

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 199 of file value.h.

Referenced by asInt64(), and isInt64().

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 184 of file value.h.

const Value Json::Value::null

static

Deprecated:: This exists for binary compatibility only. Use nullRef.

Definition at line 181 of file value.h.

const Value & Json::Value::nullRef = reinterpret_cast<const Value&>(kNullRef)

static

Definition at line 178 of file value.h.

Referenced by get(), operator[](), and removeMember().

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation