Represents a JSON value. More...

#include <json.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

typedef std::map< CZString, Value >	ObjectValues

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

typedef std::map< CZString, Value >	ObjectValues

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

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

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

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

	Value (bool value)

	Value (const Value &other)
	Deep copy.

Value &	operator= (Value other)

void	swap (Value &other)
	Swap everything.

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

ValueType	type () const

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

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!

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

bool	getString (char const begin, char const end) 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.

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

bool	operator! () const
	Return isNull()

void	clear ()

void	resize (ArrayIndex size)

Value &	operator[] (ArrayIndex index)

Value &	operator[] (int index)

const Value &	operator[] (ArrayIndex index) const

const Value &	operator[] (int index) const

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

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

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

Value &	operator[] (const char *key)

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

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

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

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

Value	get (const char begin, const char end, const Value &defaultValue) const

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

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

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

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

Value	removeMember (const std::string &key)

bool	removeMember (const char key, Value removed)

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)

bool	removeIndex (ArrayIndex i, Value *removed)
	Remove the indexed array element. More...

bool	isMember (const char *key) const

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

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

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 /* ... */.

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

bool	hasComment (CommentPlacement placement) const

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

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

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

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

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

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

	Value (bool value)

	Value (const Value &other)
	Deep copy.

Value &	operator= (Value other)

void	swap (Value &other)
	Swap everything.

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

ValueType	type () const

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

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!

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

bool	getString (char const begin, char const end) 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.

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

bool	operator! () const
	Return isNull()

void	clear ()

void	resize (ArrayIndex size)

Value &	operator[] (ArrayIndex index)

Value &	operator[] (int index)

const Value &	operator[] (ArrayIndex index) const

const Value &	operator[] (int index) const

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

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

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

Value &	operator[] (const char *key)

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

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

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

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

Value	get (const char begin, const char end, const Value &defaultValue) const

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

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

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

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

Value	removeMember (const std::string &key)

bool	removeMember (const char key, Value removed)

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)

bool	removeIndex (ArrayIndex i, Value *removed)
	Remove the indexed array element. More...

bool	isMember (const char *key) const

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

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

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 /* ... */.

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

bool	hasComment (CommentPlacement placement) const

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

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&>(kNullRef)
	We regret this reference to a global instance; prefer the simpler Value().

static const Value &	nullRef = null

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

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

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

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

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

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

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

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

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

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.

Constructor & Destructor Documentation

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); // {}

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);

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); // {}

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);

Member Function Documentation

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

Append value to array at the end.

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

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

Append value to array at the end.

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

void Json::Value::clear ( )

Remove all object members and array elements.

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

Postcondition: type() is unchanged

void Json::Value::clear ( )

Remove all object members and array elements.

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

Postcondition: type() is unchanged

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.

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.

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

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

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.

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.

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