Json::Value Class Reference

Represents a JSON value. More...

#include <json/value.h>

Collaboration diagram for Json::Value:

List of all members.

Classes

struct CommentInfo

class CZString

union ValueHolder

Public Types

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

typedef int Int

typedef unsigned int UInt

typedef ValueIterator iterator

typedef ValueConstIterator const_iterator

typedef UInt ArrayIndex

typedef std::map< CZString, Value > ObjectValues

Public Member Functions

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 StaticString &value)

Constructs a value from a static string.

Value (const std::string &value)

Value (bool value)

Value (const Value &other)

~Value ()

Value & operator= (const Value &other)

void swap (Value &other)

ValueType type () 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

bool operator== (const Value &other) const

bool operator!= (const Value &other) const

int compare (const Value &other)

const char * asCString () const

std::string asString () const

Int asInt () const

UInt asUInt () const

double asDouble () const

bool asBool () const

bool isNull () const

bool isBool () const

bool isInt () const

bool isUInt () const

bool isIntegral () const

bool isDouble () const

bool isNumeric () const

bool isString () const

bool isArray () const

bool isObject () const

bool isConvertibleTo (ValueType other) const

UInt 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 (UInt size)

Value & operator[] (UInt index)

const Value & operator[] (UInt index) const

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

bool isValidIndex (UInt index) const

Return true if index < size().

Value & append (const Value &value)

Append value to array at the end.

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

Value removeMember (const char *key)

Remove and return the named member.

Value removeMember (const std::string &key)

Same as removeMember(const char*).

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.

Members getMemberNames () const

Return a list of the member names.

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

Static Public Attributes

static const Value null

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

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

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

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

typedef int Json::Value::Int

Definition at line 120 of file value.h.

typedef ValueIterator Json::Value::iterator

Definition at line 122 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 unsigned int Json::Value::UInt

Definition at line 121 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); // {}

For internal use only.

Default constructor initialization must be equivalent to: memset( this, 0, sizeof(Value) ) This optimization is used in ValueInternalMap fast allocator.

Definition at line 529 of file json_value.cpp.

Json::Value::Value ( Int value )

Definition at line 573 of file json_value.cpp.

Json::Value::Value ( UInt value )

Definition at line 584 of file json_value.cpp.

Json::Value::Value ( double value )

Definition at line 594 of file json_value.cpp.

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

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

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

Definition at line 615 of file json_value.cpp.

References Json::intValue, Json::nullValue, and Json::uintValue.

Json::Value::Value ( bool value )

Definition at line 653 of file json_value.cpp.

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

Definition at line 664 of file json_value.cpp.

Json::Value::~Value ( )

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

bool Json::Value::asBool ( ) const

Definition at line 1041 of file json_value.cpp.

References size().

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

Definition at line 923 of file json_value.cpp.

double Json::Value::asDouble ( ) const

Definition at line 1016 of file json_value.cpp.

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

Definition at line 962 of file json_value.cpp.

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

Definition at line 931 of file json_value.cpp.

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

Definition at line 989 of file json_value.cpp.

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

Definition at line 1685 of file json_value.cpp.

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

Definition at line 1614 of file json_value.cpp.

References isArray(), isObject(), isValidIndex(), and null.

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

References isMember().

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

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

bool Json::Value::empty ( ) const

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

Definition at line 1155 of file json_value.cpp.

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

Definition at line 1720 of file json_value.cpp.

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

Definition at line 1649 of file json_value.cpp.

References isArray(), isObject(), isValidIndex(), and null.

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 1380 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 1371 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 1292 of file json_value.cpp.

References Json::stringValue.

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

Include delimiters and embedded newlines.

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

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

Definition at line 1591 of file json_value.cpp.

Referenced by operator[]().

bool Json::Value::isArray ( ) const

Definition at line 1559 of file json_value.cpp.

Referenced by begin(), end(), and Json::Reader::parse().

bool Json::Value::isBool ( ) const

Definition at line 1508 of file json_value.cpp.

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

Definition at line 1067 of file json_value.cpp.

bool Json::Value::isDouble ( ) const

Definition at line 1538 of file json_value.cpp.

bool Json::Value::isInt ( ) const

Definition at line 1515 of file json_value.cpp.

bool Json::Value::isIntegral ( ) const

Definition at line 1529 of file json_value.cpp.

References Json::in().

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

Return true if the object has a member named key.

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

Referenced by clear().

bool Json::Value::isNull ( ) const

Definition at line 1501 of file json_value.cpp.

bool Json::Value::isNumeric ( ) const

Definition at line 1545 of file json_value.cpp.

bool Json::Value::isObject ( ) const

Definition at line 1566 of file json_value.cpp.

Referenced by begin(), end(), and Json::Reader::parse().

bool Json::Value::isString ( ) const

Definition at line 1552 of file json_value.cpp.

bool Json::Value::isUInt ( ) const

Definition at line 1522 of file json_value.cpp.

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

Return true if index < size().

Definition at line 1301 of file json_value.cpp.

Referenced by begin(), and end().

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

Return isNull().

Definition at line 1165 of file json_value.cpp.

References null.

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

Definition at line 917 of file json_value.cpp.

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

Definition at line 811 of file json_value.cpp.

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

Definition at line 855 of file json_value.cpp.

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

Definition at line 754 of file json_value.cpp.

References Json::intValue, and Json::nullValue.

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

Definition at line 873 of file json_value.cpp.

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

Definition at line 867 of file json_value.cpp.

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

Definition at line 861 of file json_value.cpp.

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

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

References hasComment().

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 1328 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 1309 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 1261 of file json_value.cpp.

References Json::uintValue.

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

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

Same as removeMember(const char*).

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

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

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

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

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

Definition at line 1583 of file json_value.cpp.

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

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

Definition at line 1573 of file json_value.cpp.

Referenced by Json::Reader::parse().

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

Number of values in array or object.

Definition at line 1119 of file json_value.cpp.

Referenced by asBool().

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

Swap values.

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

Definition at line 762 of file json_value.cpp.

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

Definition at line 1606 of file json_value.cpp.

ValueType Json::Value::type ( ) const

Definition at line 774 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

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

Definition at line 128 of file value.h.

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

Definition at line 129 of file value.h.

const Value::Int Json::Value::minInt = Value::Int( ~(Value::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.

Referenced by begin(), end(), and operator!().

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

include/json/value.h
src/lib_json/json_value.cpp


Classes
struct	CommentInfo
class	CZString
union	ValueHolder
Public Types
typedef std::vector< std::string >	Members
typedef int	Int
typedef unsigned int	UInt
typedef ValueIterator	iterator
typedef ValueConstIterator	const_iterator
typedef UInt	ArrayIndex
typedef std::map< CZString, Value >	ObjectValues
Public Member Functions
	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 StaticString &value)
	Constructs a value from a static string.
	Value (const std::string &value)
	Value (bool value)
	Value (const Value &other)
	~Value ()
Value &	operator= (const Value &other)
void	swap (Value &other)
ValueType	type () 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
bool	operator== (const Value &other) const
bool	operator!= (const Value &other) const
int	compare (const Value &other)
const char *	asCString () const
std::string	asString () const
Int	asInt () const
UInt	asUInt () const
double	asDouble () const
bool	asBool () const
bool	isNull () const
bool	isBool () const
bool	isInt () const
bool	isUInt () const
bool	isIntegral () const
bool	isDouble () const
bool	isNumeric () const
bool	isString () const
bool	isArray () const
bool	isObject () const
bool	isConvertibleTo (ValueType other) const
UInt	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 (UInt size)
Value &	operator[] (UInt index)
const Value &	operator[] (UInt index) const
Value	get (UInt index, const Value &defaultValue) const
bool	isValidIndex (UInt index) const
	Return true if index < size().
Value &	append (const Value &value)
	Append value to array at the end.
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	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.
Value	removeMember (const char *key)
	Remove and return the named member.
Value	removeMember (const std::string &key)
	Same as removeMember(const char*).
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.
Members	getMemberNames () const
	Return a list of the member names.
void	setComment (const char *comment, 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 ()
Static Public Attributes
static const Value	null
static const Int	minInt = Value::Int( ~(Value::UInt(-1)/2) )
static const Int	maxInt = Value::Int( Value::UInt(-1)/2 )
static const UInt	maxUInt = Value::UInt(-1)
Friends
class	ValueIteratorBase