Represents a JSON value. More...

#include <json.h>

Public Types
typedef std::vector< 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::string	value_type

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.) 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 String &value)

	Value (bool value)

	Value (const Value &other)

	Value (Value &&other)

	~Value ()

Value &	operator= (const Value &other)

Value &	operator= (Value &&other)

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

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

void	copy (const Value &other)
	copy everything. More...

void	copyPayload (const Value &other)
	copy 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...

String	asString () const
	Embedded zeroes are possible. More...

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

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

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

void	clear ()

void	resize (ArrayIndex newSize)

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

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

Value &	append (Value &&value)

Value &	operator[] (const char *key)

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

Value &	operator[] (const String &key)

const Value &	operator[] (const 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 String &key, const Value &defaultValue) const

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

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

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

void	removeMember (const String &key)

bool	removeMember (const char key, Value removed)

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

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

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

bool	isMember (const char *key) const

bool	isMember (const String &key) const

bool	isMember (const char begin, const char end) const
	Same as isMember(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 (String comment, CommentPlacement placement)
	Comments must be //... or /* ... */. More...

bool	hasComment (CommentPlacement placement) const

String	getComment (CommentPlacement placement) const
	Include delimiters and embedded newlines. More...

String	toStyledString () const

const_iterator	begin () const

const_iterator	end () const

iterator	begin ()

iterator	end ()

void	setOffsetStart (ptrdiff_t start)

void	setOffsetLimit (ptrdiff_t limit)

ptrdiff_t	getOffsetStart () const

ptrdiff_t	getOffsetLimit () const

Static Public Member Functions
static Value const &	nullSingleton ()
	Prefer this to null or nullRef. More...

Static Public Attributes
static const Value &	null = Value::nullSingleton()

static const Value &	nullRef = Value::nullSingleton()

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
	Minimum signed 64 bits int value that can be stored in a Json::Value. More...

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

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

static const UInt	defaultRealPrecision = 17
	Default precision for real value for string representation. 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 member keys of an object 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.

Member Typedef Documentation

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

typedef ValueConstIterator Json::Value::const_iterator

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

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

typedef ValueIterator Json::Value::iterator

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

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

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

typedef std::map<CZString, Value> Json::Value::ObjectValues

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

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

typedef std::string Json::Value::value_type

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 ( Int value )

Json::Value::Value ( UInt value )

Json::Value::Value ( Int64 value )

Json::Value::Value ( UInt64 value )

Json::Value::Value ( double value )

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

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

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

Copy all, incl zeroes.

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 ( const String & value )

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

Json::Value::Value ( bool value )

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

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

Json::Value::~Value ( )

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 ( Value && value )

bool Json::Value::asBool ( ) const

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

Embedded zeroes could cause you trouble!

double Json::Value::asDouble ( ) const

float Json::Value::asFloat ( ) const

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

Int64 Json::Value::asInt64 ( ) const

LargestInt Json::Value::asLargestInt ( ) const

LargestUInt Json::Value::asLargestUInt ( ) const

String Json::Value::asString ( ) const

Embedded zeroes are possible.

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

UInt64 Json::Value::asUInt64 ( ) const

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

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

void Json::Value::clear ( )

Remove all object members and array elements.

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

Postcondition: type() is unchanged

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

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

copy everything.

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

copy values but leave comments and source offsets in place.

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

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

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

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	(	const char *	key,
		const Value &	defaultValue
	)		const

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

Note: deep copy

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.

Value Json::Value::get	(	const 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.

String Json::Value::getComment ( CommentPlacement placement ) const

Include delimiters and embedded newlines.

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

ptrdiff_t Json::Value::getOffsetLimit ( ) const

ptrdiff_t Json::Value::getOffsetStart ( ) const

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

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

bool Json::Value::isArray ( ) const

bool Json::Value::isBool ( ) const

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

bool Json::Value::isDouble ( ) const

bool Json::Value::isInt ( ) const

bool Json::Value::isInt64 ( ) const

bool Json::Value::isIntegral ( ) const

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

Return true if the object has a member named key.

Note: 'key' must be null-terminated.

bool Json::Value::isMember ( const String & key ) const

Return true if the object has a member named key.

Parameters

key	may contain embedded nulls.

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

Same as isMember(String const& key)const.

bool Json::Value::isNull ( ) const

bool Json::Value::isNumeric ( ) const

bool Json::Value::isObject ( ) const

bool Json::Value::isString ( ) const

bool Json::Value::isUInt ( ) const

bool Json::Value::isUInt64 ( ) const

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

Return true if index < size().

Value const & Json::Value::nullSingleton ( )

static

Prefer this to null or nullRef.

Json::Value::operator bool ( ) const

Return !isNull()

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

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

Compare payload only, not comments etc.

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

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

Note: Overwrite existing comments. To preserve comments, use swapPayload().

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

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

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

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

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

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

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

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

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.

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.

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

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

Parameters

key	may contain embedded nulls.

Value const & Json::Value::operator[] ( const 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.

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;

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

Remove the indexed array element.

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

Returns: true if removed (no exceptions)

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

Remove and return the named member.

Do nothing if it did not exist.

Precondition: type() is objectValue or nullValue

Postcondition: type() is unchanged

void Json::Value::removeMember ( const String & key )

Same as removeMember(const char*)

Parameters

key	may contain embedded nulls.

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.

bool Json::Value::removeMember	(	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)

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

Same as removeMember(String const& key, Value* removed)

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

Resize the array to newSize 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

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

inline

Deprecated:: Always pass len.

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

inline

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

void Json::Value::setComment	(	String	comment,
		CommentPlacement	placement
	)

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

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

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

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

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

Swap everything.

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

Swap values but leave comments and source offsets in place.

String Json::Value::toStyledString ( ) const

ValueType Json::Value::type ( ) const

Friends And Related Function Documentation

friend class ValueIteratorBase

friend

Field Documentation

unsigned int Json::Value::allocated_

const UInt Json::Value::defaultRealPrecision = 17

static

Default precision for real value for string representation.

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

static

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

const Int64 Json::Value::maxInt64

static

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

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

static

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

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

static

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

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

static

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

const UInt64 Json::Value::maxUInt64

static

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

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

static

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

const Int64 Json::Value::minInt64

static

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

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

static

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

Value const & Json::Value::null = Value::nullSingleton()

static

We regret this reference to a global instance; prefer the simpler Value().

Value const & Json::Value::nullRef = Value::nullSingleton()

static

just a kludge for binary-compatibility; same as null

unsigned int Json::Value::value_type_

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

include/jsoncpp/json/json.h
src/jsoncpp.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation