$extrastylesheet
JsonCpp project page Classes Namespace JsonCpp home page

Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends
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
typedef std::string value_type

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)
 Copy til first 0. (NULL causes to seg-fault.)
 Value (const char *begin, const char *end)
 Copy all, incl zeroes.
 Value (const StaticString &value)
 Constructs a value from a static string.
 Value (const std::string &value)
 Copy data() til size(). Embedded zeroes too.
 Value (bool value)
 Value (const Value &other)
 Deep copy.
 ~Value ()
Valueoperator= (Value other)
 Deep copy, then swap(other).
void swap (Value &other)
 Swap everything.
void swapPayload (Value &other)
 Swap values but leave comments and source offsets in place.
void copy (const Value &other)
 copy everything.
void copyPayload (const Value &other)
 copy values but leave comments and source offsets in place.
ValueType type () const
bool operator< (const Value &other) const
 Compare payload only, not comments etc.
bool operator<= (const Value &other) const
bool operator>= (const Value &other) const
bool operator> (const Value &other) const
bool operator== (const Value &other) const
bool operator!= (const Value &other) const
int compare (const Value &other) const
const char * asCString () const
 Embedded zeroes could cause you trouble!
std::string asString () const
 Embedded zeroes are possible.
bool getString (char const **begin, char const **end) const
 Get raw char* of string-value.
Int asInt () const
UInt asUInt () const
Int64 asInt64 () const
UInt64 asUInt64 () const
LargestInt asLargestInt () const
LargestUInt asLargestUInt () const
float asFloat () const
double asDouble () const
bool asBool () const
bool isNull () const
bool isBool () const
bool isInt () const
bool isInt64 () const
bool isUInt () const
bool isUInt64 () const
bool isIntegral () const
bool isDouble () const
bool isNumeric () const
bool isString () const
bool isArray () const
bool isObject () const
bool isConvertibleTo (ValueType other) const
ArrayIndex size () const
 Number of values in array or object.
bool empty () const
 Return true if empty array, empty object, or null; otherwise, false.
 operator bool () const
 Return !isNull()
void clear ()
 Remove all object members and array elements.
void resize (ArrayIndex size)
 Resize the array to size elements.
Valueoperator[] (ArrayIndex index)
 Access an array element (zero based index ).
Valueoperator[] (int index)
 Access an array element (zero based index ).
const Valueoperator[] (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 Valueoperator[] (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().
Valueappend (const Value &value)
 Append value to array at the end.
Valueoperator[] (const char *key)
 Access an object value by name, create a null member if it does not exist.
const Valueoperator[] (const char *key) const
 Access an object value by name, returns null if there is no member with that name.
Valueoperator[] (const std::string &key)
 Access an object value by name, create a null member if it does not exist.
const Valueoperator[] (const std::string &key) const
 Access an object value by name, returns null if there is no member with that name.
Valueoperator[] (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 char *begin, const char *end, 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 const * find (char const *begin, char const *end) const
 Most general and efficient version of isMember()const, get()const, and operator[]const.
Value const * demand (char const *begin, char const *end)
 Most general and efficient version of object-mutators.
void removeMember (const char *key)
 Remove and return the named member.
void removeMember (const std::string &key)
 Same as removeMember(const char*)
bool removeMember (const char *key, Value *removed)
 Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated.
bool removeMember (std::string const &key, Value *removed)
 Remove the named map member.
bool removeMember (const char *begin, const char *end, Value *removed)
 Same as removeMember(JSONCPP_STRING const& key, Value* removed)
bool removeIndex (ArrayIndex i, Value *removed)
 Remove the indexed array element.
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 isMember (const char *begin, const char *end) const
 Same as isMember(JSONCPP_STRING const& key)const.
Members getMemberNames () const
 Return a list of the member names.
void setComment (const char *comment, CommentPlacement placement)
void setComment (const char *comment, size_t len, 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 ()
void setOffsetStart (ptrdiff_t start)
void setOffsetLimit (ptrdiff_t limit)
ptrdiff_t getOffsetStart () const
ptrdiff_t getOffsetLimit () const

Static Public Member Functions

static Value const & nullSingleton ()
 Prefer this to null or nullRef.

Static Public Attributes

static const Valuenull = Value::nullSingleton()
 We regret this reference to a global instance; prefer the simpler Value().
static const ValuenullRef = Value::nullSingleton()
 just a kludge for binary-compatibility; same as 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

Detailed Description

Represents a JSON value.

This class is a discriminated union wrapper that can represents a:

The type of the held value is represented by a ValueType and can be obtained using type().

Values of an objectValue or arrayValue can be accessed using operator[]() methods. Non-const methods will automatically create the a nullValue element if it does not exist. The sequence of an arrayValue will be automatically resized and initialized with nullValue. resize() can be used to enlarge or truncate an arrayValue.

The get() methods can be used to obtain default value in the case the required element does not exist.

It is possible to iterate over the list of a objectValue values using the getMemberNames() method.

Note:
Value string-length fit in size_t, but keys must be < 2^30. (The reason is an implementation detail.) A #CharReader will raise an exception if a bound is exceeded to avoid security holes in your app, but the Value API does *not* check bounds. That is the responsibility of the caller.

Definition at line 177 of file value.h.


Member Typedef Documentation

Definition at line 191 of file value.h.

Definition at line 182 of file value.h.

Definition at line 184 of file value.h.

Definition at line 187 of file value.h.

Definition at line 181 of file value.h.

Definition at line 189 of file value.h.

Definition at line 190 of file value.h.

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

Definition at line 180 of file value.h.

Definition at line 183 of file value.h.

Definition at line 186 of file value.h.

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

Definition at line 194 of file value.h.


Constructor & Destructor Documentation

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

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

Definition at line 355 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 operator[](), and resize().

+ Here is the caller graph for this function:

Json::Value::Value ( Int  value)

Definition at line 384 of file json_value.cpp.

References Json::intValue.

Definition at line 389 of file json_value.cpp.

References Json::uintValue.

Definition at line 394 of file json_value.cpp.

References Json::intValue.

Definition at line 398 of file json_value.cpp.

References Json::uintValue.

Json::Value::Value ( double  value)

Definition at line 404 of file json_value.cpp.

References Json::realValue.

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

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

Definition at line 409 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), JSON_ASSERT_MESSAGE, and Json::stringValue.

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

Copy all, incl zeroes.

Definition at line 415 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

Json::Value::Value ( const StaticString value)

Constructs a value from a static string.

Like other value string constructor but do not duplicate the string for internal storage. The given string must remain alive after the call to this constructor.

Note:
This works only for null-terminated strings. (We cannot change the size of this class, so we have nowhere to store the length, which might be computed later for various operations.)

Example of usage:

 static StaticString foo("some text");
 Json::Value aValue(foo);

Definition at line 427 of file json_value.cpp.

References Json::StaticString::c_str(), and Json::stringValue.

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

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

Definition at line 421 of file json_value.cpp.

References Json::duplicateAndPrefixStringValue(), and Json::stringValue.

Json::Value::Value ( bool  value)

Definition at line 439 of file json_value.cpp.

References Json::booleanValue.

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

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

References size().

bool Json::Value::asBool ( ) const

Definition at line 882 of file json_value.cpp.

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

Referenced by Json::CharReaderBuilder::newCharReader().

+ Here is the caller graph for this function:

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

Embedded zeroes could cause you trouble!

Definition at line 666 of file json_value.cpp.

References Json::decodePrefixedString(), JSON_ASSERT_MESSAGE, and Json::stringValue.

double Json::Value::asDouble ( ) const

Definition at line 837 of file json_value.cpp.

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

Referenced by isConvertibleTo().

+ Here is the caller graph for this function:

float Json::Value::asFloat ( ) const

Definition at line 778 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isInt64(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxInt64, minInt64, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestInt().

+ Here is the caller graph for this function:

Definition at line 821 of file json_value.cpp.

References asInt(), and asInt64().

Definition at line 829 of file json_value.cpp.

References asUInt(), and asUInt64().

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

Embedded zeroes are possible.

Definition at line 697 of file json_value.cpp.

References Json::booleanValue, Json::decodePrefixedString(), Json::intValue, JSON_FAIL_MESSAGE, JSONCPP_STRING, Json::nullValue, Json::realValue, Json::stringValue, Json::uintValue, and Json::valueToString().

Referenced by isConvertibleTo().

+ Here is the caller graph for this function:

Definition at line 754 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isUInt(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxUInt, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestUInt().

+ Here is the caller graph for this function:

Definition at line 799 of file json_value.cpp.

References Json::booleanValue, Json::InRange(), Json::intValue, isUInt64(), JSON_ASSERT_MESSAGE, JSON_FAIL_MESSAGE, maxUInt64, Json::nullValue, Json::realValue, and Json::uintValue.

Referenced by asLargestUInt().

+ Here is the caller graph for this function:

Definition at line 1464 of file json_value.cpp.

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

Definition at line 1490 of file json_value.cpp.

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

Remove all object members and array elements.

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

Definition at line 967 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, 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 558 of file json_value.cpp.

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

copy everything.

Definition at line 549 of file json_value.cpp.

References copyPayload().

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

copy values but leave comments and source offsets in place.

Definition at line 536 of file json_value.cpp.

Referenced by copy().

+ Here is the caller graph for this function:

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

Most general and efficient version of object-mutators.

Note:
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30
Returns:
non-zero, but JSON_ASSERT if this is neither object nor nullValue.
bool Json::Value::empty ( ) const

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

Definition at line 958 of file json_value.cpp.

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

Definition at line 1477 of file json_value.cpp.

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

Definition at line 1503 of file json_value.cpp.

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

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

Most general and efficient version of isMember()const, get()const, and operator[]const.

Note:
As stated elsewhere, behavior is undefined if (end-begin) >= 2^30

Definition at line 1100 of file json_value.cpp.

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

Referenced by get(), isMember(), and operator[]().

+ Here is the caller graph for this function:

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

References nullSingleton().

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

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

Note:
deep copy

Definition at line 1159 of file json_value.cpp.

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

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

Note:
deep copy
key may contain embedded nulls.

Definition at line 1154 of file json_value.cpp.

References find().

Value Json::Value::get ( const std::string &  key,
const Value defaultValue 
) const

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

Note:
deep copy
Parameters:
keymay contain embedded nulls.

Definition at line 1163 of file json_value.cpp.

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

Include delimiters and embedded newlines.

Definition at line 1440 of file json_value.cpp.

References hasComment().

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

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

Referenced by Json::CharReaderBuilder::validate().

+ Here is the caller graph for this function:

ptrdiff_t Json::Value::getOffsetLimit ( ) const

Definition at line 1452 of file json_value.cpp.

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

+ Here is the caller graph for this function:

ptrdiff_t Json::Value::getOffsetStart ( ) const

Definition at line 1450 of file json_value.cpp.

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

+ Here is the caller graph for this function:

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

Get raw char* of string-value.

Returns:
false if !string. (Seg-fault if str or end are NULL.)

Definition at line 688 of file json_value.cpp.

References Json::decodePrefixedString(), and Json::stringValue.

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

Definition at line 1436 of file json_value.cpp.

Referenced by getComment(), and toStyledString().

+ Here is the caller graph for this function:

bool Json::Value::isArray ( ) const

Definition at line 1414 of file json_value.cpp.

References Json::arrayValue.

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

References Json::booleanValue.

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

Definition at line 1408 of file json_value.cpp.

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

Referenced by isNumeric().

+ Here is the caller graph for this function:

bool Json::Value::isInt ( ) const

Definition at line 1306 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxInt, minInt, Json::realValue, and Json::uintValue.

Referenced by asInt(), and isConvertibleTo().

+ Here is the caller graph for this function:

bool Json::Value::isInt64 ( ) const

Definition at line 1348 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxInt64, minInt64, Json::realValue, and Json::uintValue.

Referenced by asInt64().

+ Here is the caller graph for this function:

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

Return true if the object has a member named key.

Note:
'key' must be null-terminated.

Definition at line 1240 of file json_value.cpp.

Referenced by isMember().

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

Parameters:
keymay contain embedded nulls.

Definition at line 1244 of file json_value.cpp.

References isMember().

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

Same as isMember(JSONCPP_STRING const& key)const.

Definition at line 1235 of file json_value.cpp.

References find().

bool Json::Value::isNull ( ) const

Definition at line 1302 of file json_value.cpp.

References Json::nullValue.

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

+ Here is the caller graph for this function:

bool Json::Value::isNumeric ( ) const

Definition at line 1410 of file json_value.cpp.

References isDouble().

Referenced by isConvertibleTo().

+ Here is the caller graph for this function:

bool Json::Value::isObject ( ) const

Definition at line 1416 of file json_value.cpp.

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

References Json::stringValue.

bool Json::Value::isUInt ( ) const

Definition at line 1325 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), maxUInt, Json::realValue, and Json::uintValue.

Referenced by asUInt(), and isConvertibleTo().

+ Here is the caller graph for this function:

bool Json::Value::isUInt64 ( ) const

Definition at line 1368 of file json_value.cpp.

References Json::intValue, Json::IsIntegral(), Json::maxUInt64AsDouble, Json::realValue, and Json::uintValue.

Referenced by asUInt64().

+ Here is the caller graph for this function:

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

Return true if index < size().

Definition at line 1098 of file json_value.cpp.

References size().

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

+ Here is the caller graph for this function:

Value const & Json::Value::nullSingleton ( ) [static]

Prefer this to null or nullRef.

Definition at line 40 of file json_value.cpp.

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

+ Here is the caller graph for this function:

Json::Value::operator bool ( ) const [explicit]

Return !isNull()

Definition at line 965 of file json_value.cpp.

References isNull().

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

Definition at line 664 of file json_value.cpp.

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

Definition at line 613 of file json_value.cpp.

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

Deep copy, then swap(other).

Note:
Over-write existing comments. To preserve comments, use swapPayload().

Definition at line 521 of file json_value.cpp.

References swap().

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

Definition at line 617 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[] ( 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 1001 of file json_value.cpp.

References Json::arrayValue, JSON_ASSERT_MESSAGE, nullSingleton(), Json::nullValue, and Value().

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

References JSON_ASSERT_MESSAGE.

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

References Json::arrayValue, JSON_ASSERT_MESSAGE, nullSingleton(), and Json::nullValue.

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

References JSON_ASSERT_MESSAGE.

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

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

Note:
Because of our implementation, keys are limited to 2^30 -1 chars. Exceeding that will cause an exception.

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

References find(), and nullSingleton().

Value & Json::Value::operator[] ( const std::string &  key)

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

Parameters:
keymay contain embedded nulls.

Definition at line 1128 of file json_value.cpp.

Value const & Json::Value::operator[] ( const std::string &  key) const

Access an object value by name, returns null if there is no member with that name.

Parameters:
keymay contain embedded nulls.

Definition at line 1117 of file json_value.cpp.

References find(), and nullSingleton().

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

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

If the object has no entry for that name, then the member name used to store the new entry is not duplicated. Example of use:

 Json::Value object;
 static const StaticString code("code");
 object[code] = 1234;

Definition at line 1132 of file json_value.cpp.

References Json::StaticString::c_str().

bool Json::Value::removeIndex ( ArrayIndex  i,
Value removed 
)

Remove the indexed array element.

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

Returns:
true iff removed (no exceptions)

Definition at line 1205 of file json_value.cpp.

References Json::arrayValue, and size().

void 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
Deprecated:

Definition at line 1190 of file json_value.cpp.

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

Referenced by removeMember().

+ Here is the caller graph for this function:

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

Same as removeMember(const char*)

Parameters:
keymay contain embedded nulls.
Deprecated:

Definition at line 1200 of file json_value.cpp.

References removeMember().

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

Same as removeMember(const char* begin, const char* end, Value* removed), but 'key' is null-terminated.

Definition at line 1182 of file json_value.cpp.

References removeMember().

bool Json::Value::removeMember ( std::string const &  key,
Value removed 
)

Remove the named map member.

Update 'removed' iff removed.

Parameters:
keymay contain embedded nulls.
Returns:
true iff removed (no exceptions)

Definition at line 1186 of file json_value.cpp.

References removeMember().

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

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

Definition at line 1169 of file json_value.cpp.

References Json::objectValue.

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

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

void Json::Value::setComment ( const char *  comment,
CommentPlacement  placement 
)
Deprecated:
Always pass len.

Definition at line 1428 of file json_value.cpp.

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

+ Here is the caller graph for this function:

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

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

Definition at line 1418 of file json_value.cpp.

References Json::numberOfCommentPlacement.

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

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

Definition at line 1432 of file json_value.cpp.

References setComment().

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

Definition at line 1448 of file json_value.cpp.

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

Definition at line 1446 of file json_value.cpp.

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

Swap everything.

Definition at line 542 of file json_value.cpp.

References swapPayload().

Referenced by operator=(), and swapPayload().

+ Here is the caller graph for this function:

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

Swap values but leave comments and source offsets in place.

Definition at line 526 of file json_value.cpp.

References swap().

Referenced by swap().

+ Here is the caller graph for this function:

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

Definition at line 556 of file json_value.cpp.


Friends And Related Function Documentation

friend class ValueIteratorBase [friend]

Definition at line 178 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 210 of file value.h.

Referenced by asInt(), Json::duplicateAndPrefixStringValue(), Json::duplicateStringValue(), isConvertibleTo(), and isInt().

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

Referenced by asInt64(), and isInt64().

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

Definition at line 203 of file value.h.

Referenced by Json::valueToString().

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

Definition at line 205 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 212 of file value.h.

Referenced by asUInt(), isConvertibleTo(), isIntegral(), and isUInt().

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

Referenced by asInt(), isConvertibleTo(), isInt(), and isIntegral().

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

Referenced by asInt64(), isInt64(), and isIntegral().

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

Definition at line 201 of file value.h.

Referenced by Json::valueToString().

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

Definition at line 196 of file value.h.

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

just a kludge for binary-compatibility; same as null

Definition at line 197 of file value.h.


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