Represents a JSON value. More...

#include <value.h>

Classes
struct	CommentInfo
class	CZString
union	ValueHolder
Public Types
typedef UInt	ArrayIndex
typedef ValueConstIterator	const_iterator
typedef Json::Int	Int
typedef ValueIterator	iterator
typedef std::vector< std::string >	Members
typedef std::map< CZString, Value >	ObjectValues
typedef Json::UInt	UInt
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
Int	asInt () const
std::string	asString () const
UInt	asUInt () const
const_iterator	begin () const
iterator	begin ()
void	clear ()
int	compare (const Value &other)
bool	empty () const
	Return true if empty array, empty object, or null; otherwise, false.
const_iterator	end () const
iterator	end ()
Value	get (UInt 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 (UInt 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[] (UInt index)
const Value &	operator[] (UInt 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 (UInt size)
void	setComment (const char *comment, CommentPlacement placement)
	Comments must be //... or /* ... */.
void	setComment (const std::string &comment, CommentPlacement placement)
	Comments must be //... or /* ... */.
UInt	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 (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 )
static const UInt	maxUInt = UInt(-1)
static const Int	minInt = Int( ~(UInt(-1)/2) )
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 111 of file value.h.

Member Typedef Documentation

typedef UInt Json::Value::ArrayIndex

Definition at line 124 of file value.h.

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 121 of file value.h.

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

Definition at line 123 of file value.h.

typedef ValueIterator Json::Value::iterator

Definition at line 120 of file value.h.

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

Definition at line 119 of file value.h.

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

Definition at line 161 of file value.h.

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

Definition at line 122 of file value.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 268 of file json_value.cpp.

Json::Value::Value ( Int value )

Definition at line 312 of file json_value.cpp.

Json::Value::Value ( UInt value )

Definition at line 323 of file json_value.cpp.

Json::Value::Value ( double value )

Definition at line 333 of file json_value.cpp.

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

Definition at line 343 of file json_value.cpp.

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

Definition at line 355 of file json_value.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 382 of file json_value.cpp.

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

Definition at line 369 of file json_value.cpp.

Json::Value::Value ( bool value )

Definition at line 407 of file json_value.cpp.

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

Definition at line 418 of file json_value.cpp.

Json::Value::~Value ( )

Definition at line 472 of file json_value.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 1118 of file json_value.cpp.

bool Json::Value::asBool ( ) const

Definition at line 795 of file json_value.cpp.

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

Definition at line 677 of file json_value.cpp.

double Json::Value::asDouble ( ) const

Definition at line 770 of file json_value.cpp.

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

Definition at line 716 of file json_value.cpp.

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

Definition at line 685 of file json_value.cpp.

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

Definition at line 743 of file json_value.cpp.

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

Definition at line 1368 of file json_value.cpp.

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

Definition at line 1439 of file json_value.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 926 of file json_value.cpp.

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

Definition at line 535 of file json_value.cpp.

bool Json::Value::empty ( ) const

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

Definition at line 909 of file json_value.cpp.

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

Definition at line 1403 of file json_value.cpp.

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

Definition at line 1474 of file json_value.cpp.

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

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

Definition at line 1046 of file json_value.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 1125 of file json_value.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 1134 of file json_value.cpp.

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

Include delimiters and embedded newlines.

Definition at line 1351 of file json_value.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 1205 of file json_value.cpp.

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

Definition at line 1345 of file json_value.cpp.

bool Json::Value::isArray ( ) const

Definition at line 1313 of file json_value.cpp.

bool Json::Value::isBool ( ) const

Definition at line 1262 of file json_value.cpp.

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

Definition at line 821 of file json_value.cpp.

bool Json::Value::isDouble ( ) const

Definition at line 1292 of file json_value.cpp.

bool Json::Value::isInt ( ) const

Definition at line 1269 of file json_value.cpp.

bool Json::Value::isIntegral ( ) const

Definition at line 1283 of file json_value.cpp.

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

Return true if the object has a member named key.

Definition at line 1182 of file json_value.cpp.

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

Return true if the object has a member named key.

Definition at line 1190 of file json_value.cpp.

bool Json::Value::isNull ( ) const

Definition at line 1255 of file json_value.cpp.

bool Json::Value::isNumeric ( ) const

Definition at line 1299 of file json_value.cpp.

bool Json::Value::isObject ( ) const

Definition at line 1320 of file json_value.cpp.

bool Json::Value::isString ( ) const

Definition at line 1306 of file json_value.cpp.

bool Json::Value::isUInt ( ) const

Definition at line 1276 of file json_value.cpp.

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

Return true if index < size().

Definition at line 1055 of file json_value.cpp.

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

Return isNull()

Definition at line 919 of file json_value.cpp.

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

Definition at line 671 of file json_value.cpp.

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

Definition at line 565 of file json_value.cpp.

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

Definition at line 609 of file json_value.cpp.

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

Definition at line 508 of file json_value.cpp.

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

Definition at line 627 of file json_value.cpp.

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

Definition at line 621 of file json_value.cpp.

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

Definition at line 615 of file json_value.cpp.

Value & Json::Value::operator[] ( UInt 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 975 of file json_value.cpp.

const Value & Json::Value::operator[] ( UInt 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 996 of file json_value.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 1015 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 1063 of file json_value.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 1082 of file json_value.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 1089 of file json_value.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 1095 of file json_value.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 1141 of file json_value.cpp.

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

Same as removeMember(const char*)

Definition at line 1167 of file json_value.cpp.

void Json::Value::resize ( UInt 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 951 of file json_value.cpp.

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

Definition at line 1022 of file json_value.cpp.

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

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

Definition at line 1327 of file json_value.cpp.

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

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

Definition at line 1337 of file json_value.cpp.

Value::UInt Json::Value::size ( ) const

Number of values in array or object.

Definition at line 873 of file json_value.cpp.

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

Swap values.

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

Definition at line 516 of file json_value.cpp.

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

Definition at line 1360 of file json_value.cpp.

ValueType Json::Value::type ( ) const

Definition at line 528 of file json_value.cpp.

Friends And Related Function Documentation

friend class ValueIteratorBase [friend]

Definition at line 113 of file value.h.

Member Data Documentation

int Json::Value::allocated_ [private]

Definition at line 440 of file value.h.

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

Definition at line 445 of file value.h.

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

Definition at line 128 of file value.h.

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

Definition at line 129 of file value.h.

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

Definition at line 127 of file value.h.

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

Definition at line 126 of file value.h.

ValueType Json::Value::type_ [private]

Definition at line 439 of file value.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