Represents a JSON value. More...

#include <json.h>

Classes
struct	CommentInfo
class	CZString
union	ValueHolder
Public Types
typedef Json::ArrayIndex	ArrayIndex
typedef ValueConstIterator	const_iterator
typedef Json::Int	Int
typedef Json::Int64	Int64
typedef ValueIterator	iterator
typedef Json::LargestInt	LargestInt
typedef Json::LargestUInt	LargestUInt
typedef std::vector< std::string >	Members
typedef std::map< CZString, Value >	ObjectValues
typedef Json::UInt	UInt
typedef Json::UInt64	UInt64
Public Member Functions
Value &	append (const Value &value)
	Append value to array at the end.
bool	asBool () const
const char *	asCString () const
double	asDouble () const
float	asFloat () const
Int	asInt () const
Int64	asInt64 () const
LargestInt	asLargestInt () const
LargestUInt	asLargestUInt () const
std::string	asString () const
UInt	asUInt () const
UInt64	asUInt64 () const
const_iterator	begin () const
iterator	begin ()
void	clear ()
int	compare (const Value &other) const
bool	empty () const
	Return true if empty array, empty object, or null; otherwise, false.
const_iterator	end () const
iterator	end ()
Value	get (ArrayIndex index, const Value &defaultValue) const
Value	get (const char *key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise.
Value	get (const std::string &key, const Value &defaultValue) const
	Return the member named key if it exist, defaultValue otherwise.
std::string	getComment (CommentPlacement placement) const
	Include delimiters and embedded newlines.
Members	getMemberNames () const
	Return a list of the member names.
bool	hasComment (CommentPlacement placement) const
bool	isArray () const
bool	isBool () const
bool	isConvertibleTo (ValueType other) const
bool	isDouble () const
bool	isInt () const
bool	isIntegral () const
bool	isMember (const char *key) const
	Return true if the object has a member named key.
bool	isMember (const std::string &key) const
	Return true if the object has a member named key.
bool	isNull () const
bool	isNumeric () const
bool	isObject () const
bool	isString () const
bool	isUInt () const
bool	isValidIndex (ArrayIndex index) const
	Return true if index < size().
bool	operator! () const
	Return isNull()
bool	operator!= (const Value &other) const
bool	operator< (const Value &other) const
bool	operator<= (const Value &other) const
Value &	operator= (const Value &other)
bool	operator== (const Value &other) const
bool	operator> (const Value &other) const
bool	operator>= (const Value &other) const
Value &	operator[] (ArrayIndex index)
Value &	operator[] (int index)
const Value &	operator[] (ArrayIndex index) const
const Value &	operator[] (int index) const
Value &	operator[] (const char *key)
	Access an object value by name, create a null member if it does not exist.
const Value &	operator[] (const char *key) const
	Access an object value by name, returns null if there is no member with that name.
Value &	operator[] (const std::string &key)
	Access an object value by name, create a null member if it does not exist.
const Value &	operator[] (const std::string &key) const
	Access an object value by name, returns null if there is no member with that name.
Value &	operator[] (const StaticString &key)
	Access an object value by name, create a null member if it does not exist.
Value	removeMember (const char *key)
	Remove and return the named member.
Value	removeMember (const std::string &key)
	Same as removeMember(const char*)
void	resize (ArrayIndex size)
void	setComment (const char *comment, CommentPlacement placement)
	Comments must be //... or /* ... */.
void	setComment (const std::string &comment, CommentPlacement placement)
	Comments must be //... or /* ... */.
ArrayIndex	size () const
	Number of values in array or object.
void	swap (Value &other)
std::string	toStyledString () const
ValueType	type () const
	Value (ValueType type=nullValue)
	Create a default Value of the given type.
	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.
	Value (const std::string &value)
	Value (bool value)
	Value (const Value &other)
	~Value ()
Static Public Attributes
static const Int	maxInt = Int( UInt(-1)/2 )
	Maximum signed int value that can be stored in a Json::Value.
static const Int64	maxInt64 = Int64( UInt64(-1)/2 )
	Maximum signed 64 bits int 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 UInt	maxUInt = UInt(-1)
	Maximum unsigned int value that can be stored in a Json::Value.
static const UInt64	maxUInt64 = UInt64(-1)
	Maximum unsigned 64 bits int 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 Int64	minInt64 = Int64( ~(UInt64(-1)/2) )
	Minimum signed 64 bits int value that can be stored in a Json::Value.
static const LargestInt	minLargestInt = LargestInt( ~(LargestUInt(-1)/2) )
	Minimum signed integer value that can be stored in a Json::Value.
static const Value	null
Private Member Functions
Value &	resolveReference (const char *key, bool isStatic)
Private Attributes
int	allocated_: 1
CommentInfo *	comments_
ValueType	type_: 8
union Json::Value::ValueHolder	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 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 433 of file json.h.

Member Typedef Documentation

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

Definition at line 452 of file json.h.

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 443 of file json.h.

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

Definition at line 445 of file json.h.

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

Definition at line 448 of file json.h.

typedef ValueIterator Json::Value::iterator

Definition at line 442 of file json.h.

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

Definition at line 450 of file json.h.

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

Definition at line 451 of file json.h.

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

Definition at line 441 of file json.h.

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

Definition at line 506 of file json.h.

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

Definition at line 444 of file json.h.

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

Definition at line 447 of file json.h.

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

Definition at line 1776 of file jsoncpp.cpp.

Json::Value::Value ( Int value )

Json::Value::Value ( UInt value )

Json::Value::Value ( Int64 value )

Definition at line 1844 of file jsoncpp.cpp.

Json::Value::Value ( UInt64 value )

Definition at line 1855 of file jsoncpp.cpp.

Json::Value::Value ( double value )

Definition at line 1865 of file jsoncpp.cpp.

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

Definition at line 1875 of file jsoncpp.cpp.

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

Definition at line 1887 of file jsoncpp.cpp.

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 1914 of file jsoncpp.cpp.

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

Definition at line 1901 of file jsoncpp.cpp.

Json::Value::Value ( bool value )

Definition at line 1939 of file jsoncpp.cpp.

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

Definition at line 1950 of file jsoncpp.cpp.

Json::Value::~Value ( )

Definition at line 2004 of file jsoncpp.cpp.

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 2769 of file jsoncpp.cpp.

bool Json::Value::asBool ( ) const

Definition at line 2428 of file jsoncpp.cpp.

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

Definition at line 2190 of file jsoncpp.cpp.

double Json::Value::asDouble ( ) const

Definition at line 2370 of file jsoncpp.cpp.

float Json::Value::asFloat ( ) const

Definition at line 2399 of file jsoncpp.cpp.

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

Definition at line 2230 of file jsoncpp.cpp.

Int64 Json::Value::asInt64 ( ) const

LargestInt Json::Value::asLargestInt ( ) const

Definition at line 2348 of file jsoncpp.cpp.

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 2359 of file jsoncpp.cpp.

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

Definition at line 2198 of file jsoncpp.cpp.

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

Definition at line 2259 of file jsoncpp.cpp.

UInt64 Json::Value::asUInt64 ( ) const

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

Definition at line 3019 of file jsoncpp.cpp.

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

Definition at line 3090 of file jsoncpp.cpp.

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 2559 of file jsoncpp.cpp.

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

Definition at line 2067 of file jsoncpp.cpp.

bool Json::Value::empty ( ) const

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

Definition at line 2542 of file jsoncpp.cpp.

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

Definition at line 3054 of file jsoncpp.cpp.

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

Definition at line 3125 of file jsoncpp.cpp.

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 2697 of file jsoncpp.cpp.

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

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

Definition at line 2776 of file jsoncpp.cpp.

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 2785 of file jsoncpp.cpp.

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

Include delimiters and embedded newlines.

Definition at line 3002 of file jsoncpp.cpp.

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 2856 of file jsoncpp.cpp.

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

Definition at line 2996 of file jsoncpp.cpp.

bool Json::Value::isArray ( ) const

Definition at line 2964 of file jsoncpp.cpp.

bool Json::Value::isBool ( ) const

Definition at line 2913 of file jsoncpp.cpp.

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

Definition at line 2454 of file jsoncpp.cpp.

bool Json::Value::isDouble ( ) const

Definition at line 2943 of file jsoncpp.cpp.

bool Json::Value::isInt ( ) const

Definition at line 2920 of file jsoncpp.cpp.

bool Json::Value::isIntegral ( ) const

Definition at line 2934 of file jsoncpp.cpp.

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

Return true if the object has a member named key.

Definition at line 2833 of file jsoncpp.cpp.

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

Return true if the object has a member named key.

Definition at line 2841 of file jsoncpp.cpp.

bool Json::Value::isNull ( ) const

Definition at line 2906 of file jsoncpp.cpp.

bool Json::Value::isNumeric ( ) const

Definition at line 2950 of file jsoncpp.cpp.

bool Json::Value::isObject ( ) const

Definition at line 2971 of file jsoncpp.cpp.

bool Json::Value::isString ( ) const

Definition at line 2957 of file jsoncpp.cpp.

bool Json::Value::isUInt ( ) const

Definition at line 2927 of file jsoncpp.cpp.

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

Return true if index < size().

Definition at line 2706 of file jsoncpp.cpp.

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

Return isNull()

Definition at line 2552 of file jsoncpp.cpp.

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

Definition at line 2184 of file jsoncpp.cpp.

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

Definition at line 2078 of file jsoncpp.cpp.

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

Definition at line 2122 of file jsoncpp.cpp.

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

Definition at line 2040 of file jsoncpp.cpp.

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

Definition at line 2140 of file jsoncpp.cpp.

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

Definition at line 2134 of file jsoncpp.cpp.

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

Definition at line 2128 of file jsoncpp.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 2610 of file jsoncpp.cpp.

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 2631 of file jsoncpp.cpp.

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 2639 of file jsoncpp.cpp.

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 2658 of file jsoncpp.cpp.

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 2666 of file jsoncpp.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 2714 of file jsoncpp.cpp.

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 2733 of file jsoncpp.cpp.

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 2740 of file jsoncpp.cpp.

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 2746 of file jsoncpp.cpp.

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 2792 of file jsoncpp.cpp.

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

Same as removeMember(const char*)

Definition at line 2818 of file jsoncpp.cpp.

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 2584 of file jsoncpp.cpp.

Value & Json::Value::resolveReference	(	const char *	key,
		bool	isStatic
	)		`[private]`

Definition at line 2673 of file jsoncpp.cpp.

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

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

Definition at line 2978 of file jsoncpp.cpp.

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

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

Definition at line 2988 of file jsoncpp.cpp.

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

Definition at line 2506 of file jsoncpp.cpp.

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

Swap values.

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

Definition at line 2048 of file jsoncpp.cpp.

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

Definition at line 3011 of file jsoncpp.cpp.

ValueType Json::Value::type ( ) const

Definition at line 2060 of file jsoncpp.cpp.

Friends And Related Function Documentation

friend class ValueIteratorBase [friend]

Definition at line 435 of file json.h.

Member Data Documentation

int Json::Value::allocated_ [private]

Definition at line 808 of file json.h.

CommentInfo* Json::Value::comments_ [private]

Definition at line 813 of file json.h.

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 465 of file json.h.

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 472 of file json.h.

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 458 of file json.h.

const LargestUInt Json::Value::maxLargestUInt = LargestUInt(-1) [static]

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

Definition at line 460 of file json.h.

const UInt Json::Value::maxUInt = UInt(-1) [static]

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

Definition at line 467 of file json.h.

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 474 of file json.h.

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 463 of file json.h.

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 470 of file json.h.

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 456 of file json.h.

const Value Json::Value::null [static]

Definition at line 454 of file json.h.

ValueType Json::Value::type_ [private]

Definition at line 807 of file json.h.

union Json::Value::ValueHolder Json::Value::value_ [private]

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation