Medical Imaging Interaction Toolkit  2018.4.99-b585543d
Medical Imaging Interaction Toolkit
Json::Value Class Reference

Represents a JSON value. More...

#include <jsoncpp.h>

Collaboration diagram for Json::Value:

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::map< CZString, ValueObjectValues
 

Public Member Functions

 Value (ValueType type=nullValue)
 Create a default Value of the given type. More...
 
 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. More...
 
 Value (const std::string &value)
 
 Value (bool value)
 
 Value (const Value &other)
 
 ~Value ()
 
Valueoperator= (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
 
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. More...
 
bool empty () const
 Return true if empty array, empty object, or null; otherwise, false. More...
 
bool operator! () const
 Return isNull() More...
 
void clear ()
 
void resize (ArrayIndex size)
 
Valueoperator[] (ArrayIndex index)
 
Valueoperator[] (int index)
 
const Valueoperator[] (ArrayIndex index) const
 
const Valueoperator[] (int index) const
 
Value get (ArrayIndex index, const Value &defaultValue) const
 
bool isValidIndex (ArrayIndex index) const
 Return true if index < size(). More...
 
Valueappend (const Value &value)
 Append value to array at the end. More...
 
Valueoperator[] (const char *key)
 Access an object value by name, create a null member if it does not exist. More...
 
const Valueoperator[] (const char *key) const
 Access an object value by name, returns null if there is no member with that name. More...
 
Valueoperator[] (const std::string &key)
 Access an object value by name, create a null member if it does not exist. More...
 
const Valueoperator[] (const std::string &key) const
 Access an object value by name, returns null if there is no member with that name. More...
 
Valueoperator[] (const StaticString &key)
 Access an object value by name, create a null member if it does not exist. More...
 
Value get (const char *key, const Value &defaultValue) const
 Return the member named key if it exist, defaultValue otherwise. More...
 
Value get (const std::string &key, const Value &defaultValue) const
 Return the member named key if it exist, defaultValue otherwise. More...
 
Value removeMember (const char *key)
 Remove and return the named member. More...
 
Value removeMember (const std::string &key)
 Same as removeMember(const char*) More...
 
bool isMember (const char *key) const
 Return true if the object has a member named key. More...
 
bool isMember (const std::string &key) const
 Return true if the object has a member named key. More...
 
Members getMemberNames () const
 Return a list of the member names. More...
 
void setComment (const char *comment, CommentPlacement placement)
 Comments must be //... or /* ... */. More...
 
void setComment (const std::string &comment, CommentPlacement placement)
 Comments must be //... or /* ... */. More...
 
bool hasComment (CommentPlacement placement) const
 
std::string getComment (CommentPlacement placement) const
 Include delimiters and embedded newlines. More...
 
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
 Minimum signed integer value that can be stored in a Json::Value. More...
 
static const LargestInt maxLargestInt
 Maximum signed integer value that can be stored in a Json::Value. More...
 
static const LargestUInt maxLargestUInt
 Maximum unsigned integer value that can be stored in a Json::Value. More...
 
static const Int minInt
 Minimum signed int value that can be stored in a Json::Value. More...
 
static const Int maxInt
 Maximum signed int value that can be stored in a Json::Value. More...
 
static const UInt maxUInt
 Maximum unsigned int value that can be stored in a Json::Value. More...
 
static const Int64 minInt64
 Minimum signed 64 bits int value that can be stored in a Json::Value. More...
 
static const Int64 maxInt64
 Maximum signed 64 bits int value that can be stored in a Json::Value. More...
 
static const UInt64 maxUInt64
 Maximum unsigned 64 bits int value that can be stored in a Json::Value. More...
 

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 433 of file jsoncpp.h.

Member Typedef Documentation

◆ ArrayIndex

Definition at line 452 of file jsoncpp.h.

◆ const_iterator

Definition at line 443 of file jsoncpp.h.

◆ Int

Definition at line 445 of file jsoncpp.h.

◆ Int64

Definition at line 448 of file jsoncpp.h.

◆ iterator

Definition at line 442 of file jsoncpp.h.

◆ LargestInt

Definition at line 450 of file jsoncpp.h.

◆ LargestUInt

Definition at line 451 of file jsoncpp.h.

◆ Members

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

Definition at line 441 of file jsoncpp.h.

◆ ObjectValues

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

Definition at line 506 of file jsoncpp.h.

◆ UInt

Definition at line 444 of file jsoncpp.h.

◆ UInt64

Definition at line 447 of file jsoncpp.h.

Constructor & Destructor Documentation

◆ Value() [1/12]

Json::Value::Value ( ValueType  type = nullValue)

Create a default Value of the given type.

This is a very useful constructor. To create an empty array, pass arrayValue. To create an empty object, pass objectValue. Another Value can then be set to this one by assignment. This is useful since clear() and resize() will not alter types.

Examples:
Json::Value null_value; // null
Json::Value arr_value(Json::arrayValue); // []
Json::Value obj_value(Json::objectValue); // {}

Definition at line 1776 of file jsoncpp.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[](), resize(), and Value().

◆ Value() [2/12]

Json::Value::Value ( Int  value)

◆ Value() [3/12]

Json::Value::Value ( UInt  value)

◆ Value() [4/12]

Json::Value::Value ( Int64  value)

Definition at line 1844 of file jsoncpp.cpp.

◆ Value() [5/12]

Json::Value::Value ( UInt64  value)

Definition at line 1855 of file jsoncpp.cpp.

◆ Value() [6/12]

Json::Value::Value ( double  value)

Definition at line 1865 of file jsoncpp.cpp.

◆ Value() [7/12]

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

Definition at line 1875 of file jsoncpp.cpp.

References Json::duplicateStringValue().

◆ Value() [8/12]

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

Definition at line 1887 of file jsoncpp.cpp.

References Json::duplicateStringValue().

◆ Value() [9/12]

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 1914 of file jsoncpp.cpp.

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

◆ Value() [10/12]

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

Definition at line 1901 of file jsoncpp.cpp.

References Json::duplicateStringValue().

◆ Value() [11/12]

Json::Value::Value ( bool  value)

Definition at line 1939 of file jsoncpp.cpp.

◆ Value() [12/12]

◆ ~Value()

Member Function Documentation

◆ append()

Value & Json::Value::append ( const Value value)

Append value to array at the end.

Equivalent to jsonvalue[jsonvalue.size()] = value;

Definition at line 2769 of file jsoncpp.cpp.

References size().

◆ asBool()

◆ asCString()

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

◆ asDouble()

◆ asFloat()

◆ asInt()

◆ asInt64()

Int64 Json::Value::asInt64 ( ) const

Referenced by asLargestInt(), and asUInt().

◆ asLargestInt()

LargestInt Json::Value::asLargestInt ( ) const

◆ asLargestUInt()

LargestUInt Json::Value::asLargestUInt ( ) const

◆ asString()

◆ asUInt()

◆ asUInt64()

UInt64 Json::Value::asUInt64 ( ) const

Referenced by asLargestUInt(), and asUInt().

◆ begin() [1/2]

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

Definition at line 3019 of file jsoncpp.cpp.

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

◆ begin() [2/2]

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

Definition at line 3090 of file jsoncpp.cpp.

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

◆ clear()

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 2559 of file jsoncpp.cpp.

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

Referenced by resize().

◆ compare()

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

Definition at line 2067 of file jsoncpp.cpp.

◆ empty()

bool Json::Value::empty ( ) const

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

Definition at line 2542 of file jsoncpp.cpp.

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

◆ end() [1/2]

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

Definition at line 3054 of file jsoncpp.cpp.

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

◆ end() [2/2]

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

Definition at line 3125 of file jsoncpp.cpp.

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

◆ get() [1/3]

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 2697 of file jsoncpp.cpp.

References null.

Referenced by removeMember().

◆ get() [2/3]

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

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

Definition at line 2776 of file jsoncpp.cpp.

References null.

◆ get() [3/3]

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 2785 of file jsoncpp.cpp.

◆ getComment()

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

Include delimiters and embedded newlines.

Definition at line 3002 of file jsoncpp.cpp.

References hasComment().

Referenced by Json::StyledWriter::write(), and Json::StyledStreamWriter::write().

◆ getMemberNames()

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 2856 of file jsoncpp.cpp.

References equals(), JSON_ASSERT, Json::nullValue, and Json::objectValue.

Referenced by Json::FastWriter::write(), Json::StyledWriter::write(), and Json::StyledStreamWriter::write().

◆ hasComment()

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

◆ isArray()

bool Json::Value::isArray ( ) const

◆ isBool()

bool Json::Value::isBool ( ) const

Definition at line 2913 of file jsoncpp.cpp.

References Json::booleanValue.

◆ isConvertibleTo()

◆ isDouble()

bool Json::Value::isDouble ( ) const

Definition at line 2943 of file jsoncpp.cpp.

References Json::realValue.

Referenced by isNumeric().

◆ isInt()

bool Json::Value::isInt ( ) const

Definition at line 2920 of file jsoncpp.cpp.

References Json::intValue.

◆ isIntegral()

bool Json::Value::isIntegral ( ) const

Definition at line 2934 of file jsoncpp.cpp.

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

Referenced by isNumeric().

◆ isMember() [1/2]

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

Return true if the object has a member named key.

Definition at line 2833 of file jsoncpp.cpp.

References null.

Referenced by isMember().

◆ isMember() [2/2]

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

Return true if the object has a member named key.

Definition at line 2841 of file jsoncpp.cpp.

References isMember().

◆ isNull()

bool Json::Value::isNull ( ) const

Definition at line 2906 of file jsoncpp.cpp.

References Json::nullValue.

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

◆ isNumeric()

bool Json::Value::isNumeric ( ) const

Definition at line 2950 of file jsoncpp.cpp.

References isDouble(), and isIntegral().

◆ isObject()

bool Json::Value::isObject ( ) const

◆ isString()

bool Json::Value::isString ( ) const

Definition at line 2957 of file jsoncpp.cpp.

References Json::stringValue.

◆ isUInt()

bool Json::Value::isUInt ( ) const

Definition at line 2927 of file jsoncpp.cpp.

References Json::uintValue.

◆ isValidIndex()

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

Return true if index < size().

Definition at line 2706 of file jsoncpp.cpp.

References size().

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

◆ operator!()

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

Return isNull()

Definition at line 2552 of file jsoncpp.cpp.

References isNull().

◆ operator!=()

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

Definition at line 2184 of file jsoncpp.cpp.

◆ operator<()

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

◆ operator<=()

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

Definition at line 2122 of file jsoncpp.cpp.

◆ operator=()

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

Definition at line 2040 of file jsoncpp.cpp.

References swap().

◆ operator==()

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

◆ operator>()

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

Definition at line 2134 of file jsoncpp.cpp.

◆ operator>=()

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

Definition at line 2128 of file jsoncpp.cpp.

◆ operator[]() [1/9]

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 2610 of file jsoncpp.cpp.

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

Referenced by operator[]().

◆ operator[]() [2/9]

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 2631 of file jsoncpp.cpp.

References JSON_ASSERT.

◆ operator[]() [3/9]

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 2639 of file jsoncpp.cpp.

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

◆ operator[]() [4/9]

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 2658 of file jsoncpp.cpp.

References JSON_ASSERT.

◆ operator[]() [5/9]

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 2666 of file jsoncpp.cpp.

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

◆ operator[]() [6/9]

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 2714 of file jsoncpp.cpp.

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

◆ operator[]() [7/9]

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 2733 of file jsoncpp.cpp.

◆ operator[]() [8/9]

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 2740 of file jsoncpp.cpp.

◆ operator[]() [9/9]

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 2746 of file jsoncpp.cpp.

References operator[]().

◆ removeMember() [1/2]

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 2792 of file jsoncpp.cpp.

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

Referenced by removeMember().

◆ removeMember() [2/2]

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

Same as removeMember(const char*)

Definition at line 2818 of file jsoncpp.cpp.

References get(), and removeMember().

◆ resize()

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 2584 of file jsoncpp.cpp.

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

◆ setComment() [1/2]

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

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

Definition at line 2978 of file jsoncpp.cpp.

References Json::numberOfCommentPlacement.

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

◆ setComment() [2/2]

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

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

Definition at line 2988 of file jsoncpp.cpp.

References setComment().

◆ size()

◆ swap()

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

Swap values.

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

Definition at line 2048 of file jsoncpp.cpp.

References swap().

Referenced by operator=().

◆ toStyledString()

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

Definition at line 3011 of file jsoncpp.cpp.

References Json::StyledWriter::write().

◆ type()

ValueType Json::Value::type ( ) const

Member Data Documentation

◆ maxInt

const Int Json::Value::maxInt
static

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

Definition at line 465 of file jsoncpp.h.

Referenced by asInt(), isConvertibleTo(), and Json::Reader::parse().

◆ maxInt64

const Int64 Json::Value::maxInt64
static

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

Definition at line 472 of file jsoncpp.h.

Referenced by asUInt().

◆ maxLargestInt

const LargestInt Json::Value::maxLargestInt
static

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

Definition at line 458 of file jsoncpp.h.

◆ maxLargestUInt

const LargestUInt Json::Value::maxLargestUInt
static

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

Definition at line 460 of file jsoncpp.h.

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

◆ maxUInt

const UInt Json::Value::maxUInt
static

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

Definition at line 467 of file jsoncpp.h.

Referenced by asUInt(), and isConvertibleTo().

◆ maxUInt64

const UInt64 Json::Value::maxUInt64
static

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

Definition at line 474 of file jsoncpp.h.

Referenced by asUInt().

◆ minInt

const Int Json::Value::minInt
static

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

Definition at line 463 of file jsoncpp.h.

Referenced by asInt(), and isConvertibleTo().

◆ minInt64

const Int64 Json::Value::minInt64
static

Minimum signed 64 bits int value that can be stored in a Json::Value.

Definition at line 470 of file jsoncpp.h.

Referenced by asUInt().

◆ minLargestInt

const LargestInt Json::Value::minLargestInt
static

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

Definition at line 456 of file jsoncpp.h.

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

◆ null

const Value Json::Value::null
static

Definition at line 454 of file jsoncpp.h.

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


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