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

union ValueHolder

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

Public Member Functions

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

Value & operator= (const Value &other)

void swap (Value &other)

Swap values.

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

const char * asCString () const

std::string asString () 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 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

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

Remove all object members and array elements.

void resize (ArrayIndex size)

Resize the array to size elements.

Value & operator[] (ArrayIndex index)

Access an array element (zero based index ).

Value & operator[] (int index)

Access an array element (zero based index ).

const 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 & 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 get (ArrayIndex index, const Value &defaultValue) const

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

bool isValidIndex (ArrayIndex 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 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 = Int64( ~(UInt64(-1)/2) )

Minimum signed 64 bits 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 UInt64 maxUInt64 = UInt64(-1)

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

Friends

class ValueIteratorBase

class ValueInternalLink

class ValueInternalMap

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

Member Typedef Documentation

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

Definition at line 137 of file value.h.

typedef ValueConstIterator Json::Value::const_iterator

Definition at line 128 of file value.h.

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

Definition at line 130 of file value.h.

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

Definition at line 133 of file value.h.

typedef ValueIterator Json::Value::iterator

Definition at line 127 of file value.h.

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

Definition at line 135 of file value.h.

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

Definition at line 136 of file value.h.

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

Definition at line 126 of file value.h.

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

Definition at line 129 of file value.h.

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

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

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::ValueArrayAllocator::newArray(), Json::ValueMapAllocator::newMap(), Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by operator[](), and resize().

Here is the caller graph for this function:

Json::Value::Value ( Int value )

Definition at line 291 of file json_value.cpp.

Json::Value::Value ( UInt value )

Definition at line 281 of file json_value.cpp.

Json::Value::Value ( Int64 value )

Definition at line 304 of file json_value.cpp.

Json::Value::Value ( UInt64 value )

Definition at line 315 of file json_value.cpp.

Json::Value::Value ( double value )

Definition at line 325 of file json_value.cpp.

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

Definition at line 335 of file json_value.cpp.

References Json::duplicateStringValue().

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

Definition at line 347 of file json_value.cpp.

References Json::duplicateStringValue().

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

References Json::StaticString::c_str().

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

Definition at line 361 of file json_value.cpp.

References Json::duplicateStringValue().

Json::Value::Value ( bool value )

Definition at line 399 of file json_value.cpp.

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

Definition at line 410 of file json_value.cpp.

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::duplicateStringValue(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::ValueArrayAllocator::newArrayCopy(), Json::ValueMapAllocator::newMapCopy(), Json::nullValue, Json::numberOfCommentPlacement, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Json::Value::~Value ( )

Definition at line 464 of file json_value.cpp.

References Json::arrayAllocator(), Json::arrayValue, Json::booleanValue, Json::ValueArrayAllocator::destructArray(), Json::ValueMapAllocator::destructMap(), Json::intValue, JSON_ASSERT_UNREACHABLE, Json::mapAllocator(), Json::nullValue, Json::objectValue, Json::realValue, Json::releaseStringValue(), Json::stringValue, and Json::uintValue.

Referenced by Json::ValueInternalArray::resize(), and Json::ValueInternalArray::~ValueInternalArray().

Here is the caller graph for this function:

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

References size().

bool Json::Value::asBool ( ) const

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

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

Definition at line 650 of file json_value.cpp.

References JSON_ASSERT, and Json::stringValue.

double Json::Value::asDouble ( ) const

Definition at line 830 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

float Json::Value::asFloat ( ) const

Definition at line 859 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

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

Definition at line 690 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxInt, minInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by asLargestInt().

Here is the caller graph for this function:

Value::Int64 Json::Value::asInt64 ( ) const

Definition at line 751 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxInt64, minInt64, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by asLargestInt().

Here is the caller graph for this function:

LargestInt Json::Value::asLargestInt ( ) const

Definition at line 808 of file json_value.cpp.

References asInt(), and asInt64().

LargestUInt Json::Value::asLargestUInt ( ) const

Definition at line 819 of file json_value.cpp.

References asUInt(), and asUInt64().

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

Definition at line 658 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

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

Definition at line 719 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxUInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by asLargestUInt().

Here is the caller graph for this function:

Value::UInt64 Json::Value::asUInt64 ( ) const

Definition at line 779 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_MESSAGE, JSON_ASSERT_UNREACHABLE, JSON_FAIL_MESSAGE, maxUInt64, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

Referenced by asLargestUInt().

Here is the caller graph for this function:

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

Definition at line 1550 of file json_value.cpp.

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

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

Definition at line 1479 of file json_value.cpp.

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

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

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

Referenced by resize().

Here is the caller graph for this function:

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

Definition at line 527 of file json_value.cpp.

Referenced by Json::ValueInternalMap::compare(), and Json::ValueInternalArray::compare().

Here is the caller graph for this function:

bool Json::Value::empty ( ) const

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

Definition at line 1002 of file json_value.cpp.

References isArray(), isNull(), isObject(), and size().

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

Definition at line 1585 of file json_value.cpp.

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

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

Definition at line 1514 of file json_value.cpp.

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

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

References null.

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

References null.

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

Include delimiters and embedded newlines.

Definition at line 1462 of file json_value.cpp.

References hasComment().

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

References JSON_ASSERT, Json::nullValue, and Json::objectValue.

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

Definition at line 1456 of file json_value.cpp.

Referenced by getComment().

Here is the caller graph for this function:

bool Json::Value::isArray ( ) const

Definition at line 1424 of file json_value.cpp.

References Json::arrayValue, and Json::nullValue.

Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

Here is the caller graph for this function:

bool Json::Value::isBool ( ) const

Definition at line 1373 of file json_value.cpp.

References Json::booleanValue.

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

Definition at line 914 of file json_value.cpp.

References Json::arrayValue, Json::booleanValue, Json::intValue, JSON_ASSERT_UNREACHABLE, maxInt, maxUInt, minInt, Json::nullValue, Json::objectValue, Json::realValue, Json::stringValue, and Json::uintValue.

bool Json::Value::isDouble ( ) const

Definition at line 1403 of file json_value.cpp.

References Json::realValue.

Referenced by isNumeric().

Here is the caller graph for this function:

bool Json::Value::isInt ( ) const

Definition at line 1380 of file json_value.cpp.

References Json::intValue.

bool Json::Value::isIntegral ( ) const

Definition at line 1394 of file json_value.cpp.

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

Referenced by isNumeric().

Here is the caller graph for this function:

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

Return true if the object has a member named key.

Definition at line 1301 of file json_value.cpp.

References isMember().

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

Return true if the object has a member named key.

Definition at line 1293 of file json_value.cpp.

References null.

Referenced by isMember().

Here is the caller graph for this function:

bool Json::Value::isNull ( ) const

Definition at line 1366 of file json_value.cpp.

References Json::nullValue.

Referenced by empty(), and operator!().

Here is the caller graph for this function:

bool Json::Value::isNumeric ( ) const

Definition at line 1410 of file json_value.cpp.

References isDouble(), and isIntegral().

bool Json::Value::isObject ( ) const

Definition at line 1431 of file json_value.cpp.

References Json::nullValue, and Json::objectValue.

Referenced by empty(), Json::Path::make(), Json::Reader::parse(), and Json::Path::resolve().

Here is the caller graph for this function:

bool Json::Value::isString ( ) const

Definition at line 1417 of file json_value.cpp.

References Json::stringValue.

bool Json::Value::isUInt ( ) const

Definition at line 1387 of file json_value.cpp.

References Json::uintValue.

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

Return true if index < size().

Definition at line 1166 of file json_value.cpp.

References size().

Referenced by Json::Path::resolve().

Here is the caller graph for this function:

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

Return isNull().

Definition at line 1012 of file json_value.cpp.

References isNull().

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

Definition at line 644 of file json_value.cpp.

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

Definition at line 538 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::operator<= ( const Value & other ) const

Definition at line 582 of file json_value.cpp.

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

Definition at line 500 of file json_value.cpp.

References swap().

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

Definition at line 600 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::operator> ( const Value & other ) const

Definition at line 594 of file json_value.cpp.

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

Definition at line 588 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 1206 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 1200 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 1193 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 1174 of file json_value.cpp.

References JSON_ASSERT, null, Json::nullValue, and Json::objectValue.

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

References JSON_ASSERT.

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

References Json::arrayValue, JSON_ASSERT, null, and Json::nullValue.

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

References JSON_ASSERT.

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

References Json::arrayValue, JSON_ASSERT, null, Json::nullValue, and Value().

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

Same as removeMember(const char*).

Definition at line 1278 of file json_value.cpp.

References removeMember().

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

References JSON_ASSERT, null, Json::nullValue, and Json::objectValue.

Referenced by removeMember().

Here is the caller graph for this function:

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

References Json::arrayValue, clear(), JSON_ASSERT, Json::nullValue, size(), and Value().

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

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

Definition at line 1448 of file json_value.cpp.

References setComment().

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

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

Definition at line 1438 of file json_value.cpp.

References Json::numberOfCommentPlacement.

Referenced by Json::Reader::parse(), and setComment().

Here is the caller graph for this function:

ArrayIndex Json::Value::size ( ) const

Number of values in array or object.

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

Referenced by append(), empty(), isValidIndex(), and resize().

Here is the caller graph for this function:

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

Swap values.

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

Definition at line 508 of file json_value.cpp.

Referenced by Json::ValueInternalMap::doActualRemove(), and operator=().

Here is the caller graph for this function:

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

Definition at line 1471 of file json_value.cpp.

References Json::StyledWriter::write().

ValueType Json::Value::type ( ) const

Definition at line 520 of file json_value.cpp.

Friends And Related Function Documentation

friend class ValueInternalLink [friend]

Definition at line 122 of file value.h.

friend class ValueInternalMap [friend]

Definition at line 123 of file value.h.

friend class ValueIteratorBase [friend]

Definition at line 120 of file value.h.

Member Data Documentation

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

Referenced by asInt(), and isConvertibleTo().

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

Referenced by asInt64().

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

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

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

Definition at line 145 of file value.h.

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

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

Definition at line 152 of file value.h.

Referenced by asUInt(), and isConvertibleTo().

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

Referenced by asUInt64().

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

Referenced by asInt(), and isConvertibleTo().

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

Referenced by asInt64().

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

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

Definition at line 139 of file value.h.

Referenced by get(), isMember(), operator[](), removeMember(), and Json::Path::resolve().

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

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


Classes
struct	CommentInfo
union	ValueHolder
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
Public Member Functions
	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 ()
Value &	operator= (const Value &other)
void	swap (Value &other)
	Swap values.
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
const char *	asCString () const
std::string	asString () 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	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
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 ()
	Remove all object members and array elements.
void	resize (ArrayIndex size)
	Resize the array to size elements.
Value &	operator[] (ArrayIndex index)
	Access an array element (zero based index ).
Value &	operator[] (int index)
	Access an array element (zero based index ).
const 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 &	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	get (ArrayIndex index, const Value &defaultValue) const
	If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.
bool	isValidIndex (ArrayIndex 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 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 = Int64( ~(UInt64(-1)/2) )
	Minimum signed 64 bits 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 UInt64	maxUInt64 = UInt64(-1)
	Maximum unsigned 64 bits int value that can be stored in a Json::Value.
Friends
class	ValueIteratorBase
class	ValueInternalLink
class	ValueInternalMap