Traverse the children of the current value. More...

#include <UT_JSONValue.h>

Inheritance diagram for UT_JSONValue::traverser:

Public Types
using	difference_type = exint

using	value_type = UT_JSONValue

using	pointer = value_type *

using	reference = value_type &

using	iterator_category = std::forward_iterator_tag

Public Member Functions
	traverser ()

	traverser (const traverser &src)

	~traverser ()

const traverser &	operator= (const traverser &src)

traverser &	operator++ ()
	++iterator More...

bool	operator== (const traverser &rhs) const
	No post increment as it is harmful. More...

bool	operator!= (const traverser &rhs) const

const UT_JSONValue &	operator* () const

UT_JSONValue &	operator* ()

const UT_JSONValue *	operator-> () const

UT_JSONValue *	operator-> ()

bool	atEnd () const

void	advance ()

UT_JSONValue *	getValue ()

const UT_JSONValue *	getValue () const

int64	getArrayIndex () const

bool	getKey (UT_String &key)
	Deprecated in favour of UT_StringHolder method. More...

bool	getLowerCaseKey (UT_String &key)
	Deprecated in favour of UT_StringHolder method. More...

bool	getKey (UT_StringHolder &key) const

bool	getLowerCaseKey (UT_StringHolder &key)
	Get a lower case map key (for case insensitive maps) More...

Friends
class	UT_JSONValue

Detailed Description

Traverse the children of the current value.

This class will iterate over all items in this value, whether they are in the form of an array or a map. For values with neither, it will return the current value itself. Note that the getKey() function is only available when this value is a map.

Example:

UT_JSONValue::traverser it;

for (it = value.beginTraversal(); !it.atEnd(); ++it)

Definition at line 465 of file UT_JSONValue.h.

Member Typedef Documentation

using UT_JSONValue::traverser::difference_type = exint

Definition at line 468 of file UT_JSONValue.h.

using UT_JSONValue::traverser::iterator_category = std::forward_iterator_tag

Definition at line 472 of file UT_JSONValue.h.

using UT_JSONValue::traverser::pointer = value_type*

Definition at line 470 of file UT_JSONValue.h.

using UT_JSONValue::traverser::reference = value_type&

Definition at line 471 of file UT_JSONValue.h.

using UT_JSONValue::traverser::value_type = UT_JSONValue

Definition at line 469 of file UT_JSONValue.h.

Constructor & Destructor Documentation

UT_JSONValue::traverser::traverser ( )

inline

Definition at line 474 of file UT_JSONValue.h.

UT_JSONValue::traverser::traverser ( const traverser & src )

inline

Definition at line 480 of file UT_JSONValue.h.

UT_JSONValue::traverser::~traverser ( )

inline

Definition at line 484 of file UT_JSONValue.h.

Member Function Documentation

void UT_JSONValue::traverser::advance ( )

inline

Definition at line 527 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::atEnd ( ) const

inline

Definition at line 526 of file UT_JSONValue.h.

int64 UT_JSONValue::traverser::getArrayIndex ( ) const

inline

Definition at line 565 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getKey ( UT_String & key )

inline

Deprecated in favour of UT_StringHolder method.

Definition at line 576 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getKey ( UT_StringHolder & key ) const

inline

Definition at line 594 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getLowerCaseKey ( UT_String & key )

inline

Deprecated in favour of UT_StringHolder method.

Definition at line 585 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::getLowerCaseKey ( UT_StringHolder & key )

inline

Get a lower case map key (for case insensitive maps)

Definition at line 616 of file UT_JSONValue.h.

UT_JSONValue* UT_JSONValue::traverser::getValue ( )

inline

Returns the child value which corresponds to the current traversal position.

Definition at line 553 of file UT_JSONValue.h.

const UT_JSONValue* UT_JSONValue::traverser::getValue ( ) const

inline

Definition at line 559 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::operator!= ( const traverser & rhs ) const

inline

Definition at line 506 of file UT_JSONValue.h.

const UT_JSONValue& UT_JSONValue::traverser::operator* ( ) const

inline

Definition at line 510 of file UT_JSONValue.h.

UT_JSONValue& UT_JSONValue::traverser::operator* ( )

inline

Definition at line 514 of file UT_JSONValue.h.

traverser& UT_JSONValue::traverser::operator++ ( )

inline

++iterator

Definition at line 498 of file UT_JSONValue.h.

const UT_JSONValue* UT_JSONValue::traverser::operator-> ( ) const

inline

Definition at line 518 of file UT_JSONValue.h.

UT_JSONValue* UT_JSONValue::traverser::operator-> ( )

inline

Definition at line 522 of file UT_JSONValue.h.

const traverser& UT_JSONValue::traverser::operator= ( const traverser & src )

inline

Definition at line 486 of file UT_JSONValue.h.

bool UT_JSONValue::traverser::operator== ( const traverser & rhs ) const

inline

No post increment as it is harmful.

Definition at line 501 of file UT_JSONValue.h.

Friends And Related Function Documentation

friend class UT_JSONValue

friend

Definition at line 651 of file UT_JSONValue.h.

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

UT/UT_JSONValue.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation