JsonCpp project page Classes Namespace JsonCpp home page

Public Types | Public Member Functions | Protected Member Functions | List of all members
Json::ValueIteratorBase Class Reference

base class for Value iterators. More...

#include <json/value.h>

+ Inheritance diagram for Json::ValueIteratorBase:
+ Collaboration diagram for Json::ValueIteratorBase:

Public Types

typedef std::bidirectional_iterator_tag iterator_category
 
typedef unsigned int size_t
 
typedef int difference_type
 
typedef ValueIteratorBase SelfType
 

Public Member Functions

bool operator== (const SelfType &other) const
 
bool operator!= (const SelfType &other) const
 
difference_type operator- (const SelfType &other) const
 
Value key () const
 Return either the index or the member name of the referenced value as a Value. More...
 
UInt index () const
 Return the index of the referenced Value, or -1 if it is not an arrayValue. More...
 
String name () const
 Return the member name of the referenced Value, or "" if it is not an objectValue. More...
 
 __declspec (deprecated("Use `key = name();` instead.")) char const *memberName() const
 Return the member name of the referenced Value. More...
 
char const * memberName (char const **end) const
 Return the member name of the referenced Value, or NULL if it is not an objectValue. More...
 
 ValueIteratorBase ()
 
 ValueIteratorBase (const Value::ObjectValues::iterator &current)
 

Protected Member Functions

Valuederef () const
 
void increment ()
 
void decrement ()
 
difference_type computeDistance (const SelfType &other) const
 
bool isEqual (const SelfType &other) const
 
void copy (const SelfType &other)
 

Detailed Description

base class for Value iterators.

Definition at line 729 of file value.h.

Member Typedef Documentation

◆ difference_type

Definition at line 733 of file value.h.

◆ iterator_category

typedef std::bidirectional_iterator_tag Json::ValueIteratorBase::iterator_category

Definition at line 731 of file value.h.

◆ SelfType

Definition at line 734 of file value.h.

◆ size_t

typedef unsigned int Json::ValueIteratorBase::size_t

Definition at line 732 of file value.h.

Constructor & Destructor Documentation

◆ ValueIteratorBase() [1/2]

Json::ValueIteratorBase::ValueIteratorBase ( )

Definition at line 18 of file json_valueiterator.inl.

◆ ValueIteratorBase() [2/2]

Json::ValueIteratorBase::ValueIteratorBase ( const Value::ObjectValues::iterator &  current)
explicit

Definition at line 20 of file json_valueiterator.inl.

Member Function Documentation

◆ __declspec()

Json::ValueIteratorBase::__declspec ( deprecated("Use `key = name();` instead.")  ) const

Return the member name of the referenced Value.

"" if it is not an objectValue.

Deprecated:
This cannot be used for UTF-8 strings, since there can be embedded nulls.

◆ computeDistance()

ValueIteratorBase::difference_type Json::ValueIteratorBase::computeDistance ( const SelfType other) const
protected

Definition at line 31 of file json_valueiterator.inl.

Referenced by operator-().

+ Here is the caller graph for this function:

◆ copy()

void Json::ValueIteratorBase::copy ( const SelfType other)
protected

Definition at line 65 of file json_valueiterator.inl.

Referenced by Json::ValueConstIterator::operator=(), and Json::ValueIterator::operator=().

+ Here is the caller graph for this function:

◆ decrement()

void Json::ValueIteratorBase::decrement ( )
protected

Definition at line 28 of file json_valueiterator.inl.

◆ deref()

Value & Json::ValueIteratorBase::deref ( ) const
protected

Definition at line 24 of file json_valueiterator.inl.

◆ increment()

void Json::ValueIteratorBase::increment ( )
protected

Definition at line 26 of file json_valueiterator.inl.

◆ index()

UInt Json::ValueIteratorBase::index ( ) const

Return the index of the referenced Value, or -1 if it is not an arrayValue.

Definition at line 80 of file json_valueiterator.inl.

◆ isEqual()

bool Json::ValueIteratorBase::isEqual ( const SelfType other) const
protected

Definition at line 58 of file json_valueiterator.inl.

◆ key()

Value Json::ValueIteratorBase::key ( ) const

Return either the index or the member name of the referenced value as a Value.

Definition at line 70 of file json_valueiterator.inl.

◆ memberName()

char const * Json::ValueIteratorBase::memberName ( char const **  end) const

Return the member name of the referenced Value, or NULL if it is not an objectValue.

Note
Better version than memberName(). Allows embedded nulls.

Definition at line 96 of file json_valueiterator.inl.

Referenced by name().

+ Here is the caller graph for this function:

◆ name()

String Json::ValueIteratorBase::name ( ) const

Return the member name of the referenced Value, or "" if it is not an objectValue.

Note
Avoid c_str() on result, as embedded zeroes are possible.

Definition at line 87 of file json_valueiterator.inl.

References memberName().

◆ operator!=()

bool Json::ValueIteratorBase::operator!= ( const SelfType other) const
inline

Definition at line 738 of file value.h.

◆ operator-()

difference_type Json::ValueIteratorBase::operator- ( const SelfType other) const
inline

Definition at line 740 of file value.h.

References computeDistance().

◆ operator==()

bool Json::ValueIteratorBase::operator== ( const SelfType other) const
inline

Definition at line 736 of file value.h.


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