JsonCpp project page JsonCpp home page

Classes | Public Types | Public Member Functions | Static Public Attributes | Friends

Json::Value Class Reference

Represents a JSON value. More...

#include </home/iurt/rpm/BUILD/jsoncpp-src-0.5.0/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 UInt ArrayIndex

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 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 ()
Valueoperator= (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 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 ()
 Remove all object members and array elements.
void resize (UInt size)
 Resize the array to size elements.
Valueoperator[] (UInt index)
 Access an array element (zero based index ).
const Valueoperator[] (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.)
Value get (UInt index, const Value &defaultValue) const
 If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue.
bool isValidIndex (UInt 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 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 = Int( ~(UInt(-1)/2) )
static const Int maxInt = Int( UInt(-1)/2 )
static const UInt maxUInt = UInt(-1)

Friends

class ValueIteratorBase
class ValueInternalLink
class ValueInternalMap

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

Definition at line 124 of file value.h.

Definition at line 121 of file value.h.

Definition at line 123 of file value.h.

Definition at line 120 of file value.h.

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

Definition at line 119 of file value.h.

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

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

Definition at line 268 of file json_value.cpp.

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

Here is the caller graph for this function:

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)
Json::Value::Value ( const char *  beginValue,
const char *  endValue 
)
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.

References Json::StaticString::c_str().

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

Definition at line 407 of file json_value.cpp.

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

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.

References size().

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

Definition at line 677 of file json_value.cpp.

References JSON_ASSERT, and Json::stringValue.

double Json::Value::asDouble ( ) const
Value::Int Json::Value::asInt ( ) const
std::string Json::Value::asString ( ) const
Value::UInt Json::Value::asUInt ( ) const
Value::const_iterator Json::Value::begin ( ) const

Definition at line 1368 of file json_value.cpp.

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

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

Definition at line 1439 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 926 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)

Definition at line 535 of file json_value.cpp.

Referenced by 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 909 of file json_value.cpp.

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

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

Definition at line 1403 of file json_value.cpp.

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

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

Definition at line 1474 of file json_value.cpp.

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

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.

References null.

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.

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

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

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

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

Definition at line 1345 of file json_value.cpp.

Referenced by getComment().

Here is the caller graph for this function:

bool Json::Value::isArray ( ) const

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

References Json::booleanValue.

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

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

References Json::intValue.

bool Json::Value::isIntegral ( ) const

Definition at line 1283 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 1190 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 1182 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 1255 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 1299 of file json_value.cpp.

References isDouble(), and isIntegral().

bool Json::Value::isObject ( ) const

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

References Json::stringValue.

bool Json::Value::isUInt ( ) const

Definition at line 1276 of file json_value.cpp.

References Json::uintValue.

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

Return true if index < size().

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

References isNull().

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

References swap().

bool Json::Value::operator== ( const Value other) const
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[] ( 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.

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.

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

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.

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

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.

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.

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.

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.

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

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.

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

Referenced by removeMember().

Here is the caller graph for this function:

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

Same as removeMember(const char*)

Definition at line 1167 of file json_value.cpp.

References removeMember().

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.

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

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

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

Definition at line 1327 of file json_value.cpp.

References Json::numberOfCommentPlacement.

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

Here is the caller graph for this function:

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

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

Definition at line 1337 of file json_value.cpp.

References setComment().

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

Number of values in array or object.

Definition at line 873 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 516 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 1360 of file json_value.cpp.

References Json::StyledWriter::write().

ValueType Json::Value::type ( ) const

Definition at line 528 of file json_value.cpp.


Friends And Related Function Documentation

friend class ValueInternalLink [friend]

Definition at line 115 of file value.h.

friend class ValueInternalMap [friend]

Definition at line 116 of file value.h.

friend class ValueIteratorBase [friend]

Definition at line 113 of file value.h.


Member Data Documentation

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

Definition at line 128 of file value.h.

Referenced by asInt(), and isConvertibleTo().

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

Definition at line 129 of file value.h.

Referenced by asUInt(), and isConvertibleTo().

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

Definition at line 127 of file value.h.

Referenced by asInt(), and isConvertibleTo().

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

Definition at line 126 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:

SourceForge Logo hosts this site. Send comments to:
Json-cpp Developers