Represents a JSON value. More...

#include <json.h>

Public Types
typedef Aws::Vector< Aws::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 Aws::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 Aws::String &value)

	Value (bool value)

	Value (const Value &other)
	Deep copy. More...

	~Value ()

Value &	operator= (Value other)

void	swap (Value &other)
	Swap everything. More...

void	swapPayload (Value &other)
	Swap values but leave comments and source offsets in place. More...

ValueType	type () const

bool	operator< (const Value &other) const
	Compare payload only, not comments etc. More...

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

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

Value &	operator[] (ArrayIndex index)

Value &	operator[] (int index)

const Value &	operator[] (ArrayIndex index) const

const Value &	operator[] (int index) const

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

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

Value &	operator[] (const Aws::String &key)
	Access an object value by name, create a null member if it does not exist. More...

const Value &	operator[] (const Aws::String &key) const

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 Aws::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 Aws::String &key)

bool	removeMember (const char key, Value removed)
	Remove the named map member. More...

bool	removeIndex (ArrayIndex i, Value *removed)
	Remove the indexed array element. More...

bool	isMember (const char *key) const
	Return true if the object has a member named key. More...

bool	isMember (const Aws::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)

void	setComment (const char *comment, size_t len, CommentPlacement placement)
	Comments must be //... or /* ... */. More...

void	setComment (const Aws::String &comment, CommentPlacement placement)
	Comments must be //... or /* ... */. More...

bool	hasComment (CommentPlacement placement) const

Aws::String	getComment (CommentPlacement placement) const
	Include delimiters and embedded newlines. More...

Aws::String	toStyledString () const

const_iterator	begin () const

const_iterator	end () const

iterator	begin ()

iterator	end ()

void	setOffsetStart (size_t start)

void	setOffsetLimit (size_t limit)

size_t	getOffsetStart () const

size_t	getOffsetLimit () const

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

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.

Definition at line 511 of file json.h.

Member Typedef Documentation

typedef Json::ArrayIndex Aws::External::Json::Value::ArrayIndex

Definition at line 529 of file json.h.

typedef ValueConstIterator Aws::External::Json::Value::const_iterator

Definition at line 520 of file json.h.

typedef Json::Int Aws::External::Json::Value::Int

Definition at line 522 of file json.h.

typedef Json::Int64 Aws::External::Json::Value::Int64

Definition at line 525 of file json.h.

typedef ValueIterator Aws::External::Json::Value::iterator

Definition at line 519 of file json.h.

typedef Json::LargestInt Aws::External::Json::Value::LargestInt

Definition at line 527 of file json.h.

typedef Json::LargestUInt Aws::External::Json::Value::LargestUInt

Definition at line 528 of file json.h.

typedef Aws::Vector<Aws::String> Aws::External::Json::Value::Members

Definition at line 518 of file json.h.

typedef Aws::Map<CZString, Value> Aws::External::Json::Value::ObjectValues

Definition at line 584 of file json.h.

typedef Json::UInt Aws::External::Json::Value::UInt

Definition at line 521 of file json.h.

typedef Json::UInt64 Aws::External::Json::Value::UInt64

Definition at line 524 of file json.h.

Constructor & Destructor Documentation

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

Aws::External::Json::Value::Value ( Int value )

Aws::External::Json::Value::Value ( UInt value )

Aws::External::Json::Value::Value ( Int64 value )

Aws::External::Json::Value::Value ( UInt64 value )

Aws::External::Json::Value::Value ( double value )

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

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

Aws::External::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") );

Aws::External::Json::Value::Value ( const Aws::String & value )

Aws::External::Json::Value::Value ( bool value )

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

Deep copy.

Aws::External::Json::Value::~Value ( )

Member Function Documentation

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

Append value to array at the end.

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

bool Aws::External::Json::Value::asBool ( ) const

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

double Aws::External::Json::Value::asDouble ( ) const

float Aws::External::Json::Value::asFloat ( ) const

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

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

LargestInt Aws::External::Json::Value::asLargestInt ( ) const

LargestUInt Aws::External::Json::Value::asLargestUInt ( ) const

Aws::String Aws::External::Json::Value::asString ( ) const

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

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

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

iterator Aws::External::Json::Value::begin ( )

void Aws::External::Json::Value::clear ( )

Remove all object members and array elements.

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

Postcondition: type() is unchanged

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

bool Aws::External::Json::Value::empty ( ) const

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

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

iterator Aws::External::Json::Value::end ( )

Value Aws::External::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.

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

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

Value Aws::External::Json::Value::get	(	const Aws::String &	key,
		const Value &	defaultValue
	)		const

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

Aws::String Aws::External::Json::Value::getComment ( CommentPlacement placement ) const

Include delimiters and embedded newlines.

Members Aws::External::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

size_t Aws::External::Json::Value::getOffsetLimit ( ) const

size_t Aws::External::Json::Value::getOffsetStart ( ) const

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

bool Aws::External::Json::Value::isArray ( ) const

bool Aws::External::Json::Value::isBool ( ) const

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

bool Aws::External::Json::Value::isDouble ( ) const

bool Aws::External::Json::Value::isInt ( ) const

bool Aws::External::Json::Value::isInt64 ( ) const

bool Aws::External::Json::Value::isIntegral ( ) const

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

Return true if the object has a member named key.

bool Aws::External::Json::Value::isMember ( const Aws::String & key ) const

Return true if the object has a member named key.

bool Aws::External::Json::Value::isNull ( ) const

bool Aws::External::Json::Value::isNumeric ( ) const

bool Aws::External::Json::Value::isObject ( ) const

bool Aws::External::Json::Value::isString ( ) const

bool Aws::External::Json::Value::isUInt ( ) const

bool Aws::External::Json::Value::isUInt64 ( ) const

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

Return true if index < size().

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

Return isNull()

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

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

Compare payload only, not comments etc.

bool Aws::External::Json::Value::operator<= ( const Value & other ) const

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

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

bool Aws::External::Json::Value::operator> ( const Value & other ) const

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

Value& Aws::External::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.)

Value& Aws::External::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.)

const Value& Aws::External::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.)

const Value& Aws::External::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.)

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

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

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

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

Value& Aws::External::Json::Value::operator[] ( const Aws::String & key )

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

const Value& Aws::External::Json::Value::operator[] ( const Aws::String & key ) const

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

Value& Aws::External::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;

bool Aws::External::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)

Value Aws::External::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:

Value Aws::External::Json::Value::removeMember ( const Aws::String & key )

Same as removeMember(const char*)

Deprecated:

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

Remove the named map member.

Update 'removed' iff removed.

Returns: true iff removed (no exceptions)

void Aws::External::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

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

Deprecated:: Always pass len.

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

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

void Aws::External::Json::Value::setComment	(	const Aws::String &	comment,
		CommentPlacement	placement
	)

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

void Aws::External::Json::Value::setOffsetLimit ( size_t limit )

void Aws::External::Json::Value::setOffsetStart ( size_t start )

ArrayIndex Aws::External::Json::Value::size ( ) const

Number of values in array or object.

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

Swap everything.

void Aws::External::Json::Value::swapPayload ( Value & other )

Swap values but leave comments and source offsets in place.

Aws::String Aws::External::Json::Value::toStyledString ( ) const

ValueType Aws::External::Json::Value::type ( ) const

Friends And Related Function Documentation

friend class ValueIteratorBase

friend

Definition at line 512 of file json.h.

Member Data Documentation

const Int Aws::External::Json::Value::maxInt

static

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

Definition at line 542 of file json.h.

const Int64 Aws::External::Json::Value::maxInt64

static

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

Definition at line 550 of file json.h.

const LargestInt Aws::External::Json::Value::maxLargestInt

static

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

Definition at line 535 of file json.h.

const LargestUInt Aws::External::Json::Value::maxLargestUInt

static

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

Definition at line 537 of file json.h.

const UInt Aws::External::Json::Value::maxUInt

static

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

Definition at line 544 of file json.h.

const UInt64 Aws::External::Json::Value::maxUInt64

static

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

Definition at line 552 of file json.h.

const Int Aws::External::Json::Value::minInt

static

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

Definition at line 540 of file json.h.

const Int64 Aws::External::Json::Value::minInt64

static

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

Definition at line 548 of file json.h.

const LargestInt Aws::External::Json::Value::minLargestInt

static

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

Definition at line 533 of file json.h.

const Value& Aws::External::Json::Value::null

static

Definition at line 531 of file json.h.

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

aws-cpp-sdk-core/include/aws/core/external/json-cpp/json.h

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation