Value Class Reference

Represents a JSON value. More...

#include <value.h>

Public Types
typedef std::vector< std::string >	Members
typedef ValueIterator	iterator
typedef ValueConstIterator	const_iterator
typedef CSJson::UInt	UInt
typedef CSJson::Int	Int
typedef CSJson::UInt64	UInt64
typedef CSJson::Int64	Int64
typedef CSJson::LargestInt	LargestInt
typedef CSJson::LargestUInt	LargestUInt
typedef CSJson::ArrayIndex	ArrayIndex
typedef std::map< CZString, Value >	ObjectValues

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 ()
Value &	operator= (const Value &other)
void	swap (Value &other)
	Swap values. More...
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 ()
	Remove all object members and array elements. More...
void	resize (ArrayIndex size)
	Resize the array to size elements. More...
Value &	operator[] (ArrayIndex index)
	Access an array element (zero based index ). More...
Value &	operator[] (int index)
	Access an array element (zero based index ). More...
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.) More...
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.) More...
Value	get (ArrayIndex index, const Value &defaultValue) const
	If the array contains at least index+1 elements, returns the element value, otherwise returns defaultValue. More...
bool	isValidIndex (ArrayIndex index) const
	Return true if index < size(). More...
Value &	append (const Value &value)
	Append value to array at the end. More...
Value &	operator[] (const char *key)
	Access an object value by name, create a null member if it does not exist. More...
const Value &	operator[] (const char *key) const
	Access an object value by name, returns null if there is no member with that name. More...
Value &	operator[] (const std::string &key)
	Access an object value by name, create a null member if it does not exist. More...
const Value &	operator[] (const std::string &key) const
	Access an object value by name, returns null if there is no member with that name. More...
Value &	operator[] (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	jsonNull
static const LargestInt	minLargestInt
	Minimum signed integer value that can be stored in a CSJson::Value. More...
static const LargestInt	maxLargestInt
	Maximum signed integer value that can be stored in a CSJson::Value. More...
static const LargestUInt	maxLargestUInt
	Maximum unsigned integer value that can be stored in a CSJson::Value. More...
static const Int	minInt
	Minimum signed int value that can be stored in a CSJson::Value. More...
static const Int	maxInt
	Maximum signed int value that can be stored in a CSJson::Value. More...
static const UInt	maxUInt
	Maximum unsigned int value that can be stored in a CSJson::Value. More...
static const Int64	minInt64
	Minimum signed 64 bits int value that can be stored in a CSJson::Value. More...
static const Int64	maxInt64
	Maximum signed 64 bits int value that can be stored in a CSJson::Value. More...
static const UInt64	maxUInt64
	Maximum unsigned 64 bits int value that can be stored in a CSJson::Value. More...

Friends
class	ValueIteratorBase

Detailed Description

Represents a JSON value.

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

• signed integer [range: Value::minInt - Value::maxInt]
• unsigned integer (range: 0 - Value::maxUInt)
• double
• UTF-8 string
• boolean
• 'null'
• an ordered list of Value
• collection of name/value pairs (javascript object)

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

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

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

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

Member Typedef Documentation

typedef CSJson::ArrayIndex ArrayIndex

typedef ValueConstIterator const_iterator

typedef CSJson::Int Int

typedef CSJson::Int64 Int64

typedef ValueIterator iterator

typedef CSJson::LargestInt LargestInt

typedef CSJson::LargestUInt LargestUInt

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

typedef std::map<CZString, Value> ObjectValues

typedef CSJson::UInt UInt

typedef CSJson::UInt64 UInt64

Constructor & Destructor Documentation

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:

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

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.

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:

CSJson::Value aValue( StaticString("some text") );

Value

(

const std::string &

value)

Value

(

bool

value)

Value

(

const Value &

other)

~Value

(

)

Member Function Documentation

Value& append

(

const Value &

value)

Append value to array at the end.

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

bool asBool

(

)

const

const char* asCString

(

)

const

double asDouble

(

)

const

float asFloat

(

)

const

Int asInt

(

)

const

Int64 asInt64

(

)

const

LargestInt asLargestInt

(

)

const

LargestUInt asLargestUInt

(

)

const

std::string asString

(

)

const

UInt asUInt

(

)

const

UInt64 asUInt64

(

)

const

const_iterator begin

(

)

const

iterator begin

(

)

void clear

(

)

Remove all object members and array elements.

Precondition

type() is arrayValue, objectValue, or nullValue

Postcondition

type() is unchanged

int compare

(

const Value &

other)

const

bool empty

(

)

const

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

const_iterator end

(

)

const

iterator end

(

)

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

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

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.

std::string getComment

(

CommentPlacement

placement)

const

Include delimiters and embedded newlines.

Members 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

bool hasComment

(

CommentPlacement

placement)

const

bool isArray

(

)

const

bool isBool

(

)

const

bool isConvertibleTo

(

ValueType

other)

const

bool isDouble

(

)

const

bool isInt

(

)

const

bool isIntegral

(

)

const

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 isNull

(

)

const

bool isNumeric

(

)

const

bool isObject

(

)

const

bool isString

(

)

const

bool isUInt

(

)

const

bool isValidIndex

(

ArrayIndex

index)

const

Return true if index < size().

bool operator!

(

)

const

Return isNull()

bool operator!=

(

const Value &

other)

const

bool operator<

(

const Value &

other)

const

bool operator<=

(

const Value &

other)

const

Value& operator=

(

const Value &

other)

bool operator==

(

const Value &

other)

const

bool operator>

(

const Value &

other)

const

bool operator>=

(

const Value &

other)

const

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

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

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

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:

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

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

Value removeMember

(

const std::string &

key)

Same as removeMember(const char*)

void 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

void setComment	(	const char *	comment,
		CommentPlacement	placement
	)

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

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

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

ArrayIndex size

(

)

const

Number of values in array or object.

void swap

(

Value &

other)

Swap values.

Note

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

std::string toStyledString

(

)

const

ValueType type

(

)

const

Friends And Related Function Documentation

friend class ValueIteratorBase

friend

Member Data Documentation

const Value jsonNull

static

const Int maxInt

static

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

const Int64 maxInt64

static

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

const LargestInt maxLargestInt

static

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

const LargestUInt maxLargestUInt

static

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

const UInt maxUInt

static

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

const UInt64 maxUInt64

static

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

const Int minInt

static

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

const Int64 minInt64

static

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

const LargestInt minLargestInt

static

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

---

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

• /Users/cocos2d/MyWork/cocos2d-x/extensions/CocoStudio/Json/lib_json/value.h