Qore Programming Language Reference Manual
1.7.0
|
This class an iterator class for objects. More...
Public Member Methods | |
constructor (object o) | |
Creates the object iterator object. More... | |
constructor () | |
Creates an empty object iterator object. More... | |
copy () | |
Creates a copy of the ObjectPairIterator object, iterating the same object as the original and in the same position. More... | |
hash< auto > | getValue () |
returns a hash with the current key and value (a hash with 2 keys: "key" and "value" ) or throws an INVALID-ITERATOR exception if the iterator is invalid More... | |
Public Member Methods inherited from Qore::ObjectIterator | |
constructor (object o) | |
Creates the object iterator object. More... | |
constructor () | |
Creates an empty object iterator object. More... | |
copy () | |
Creates a copy of the ObjectIterator object, iterating the same object as the original and in the same position. More... | |
Public Member Methods inherited from Qore::HashIterator | |
constructor (hash< auto > h) | |
Creates the hash iterator object. More... | |
constructor () | |
Creates an empty hash iterator object. More... | |
copy () | |
Creates a copy of the HashIterator object, iterating the same object as the original and in the same position. More... | |
bool | empty () |
returns True if the hash is empty; False if not More... | |
bool | first () |
returns True if on the first element of the hash More... | |
string | getKey () |
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid More... | |
auto | getKeyValue () |
returns the current value of the current hash key being iterated or throws an INVALID-ITERATOR exception if the iterator is invalid More... | |
hash< auto > | getValuePair () |
returns a hash with the current key and value (a hash with 2 keys: "key" and "value" ) or throws an INVALID-ITERATOR exception if the iterator is invalid More... | |
bool | last () |
returns True if on the last element of the hash More... | |
bool | next () |
Moves the current position to the next element in the hash; returns False if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the first element in the hash if the hash is not empty. More... | |
bool | prev () |
Moves the current position to the previous element in the hash; returns False if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the last element in the hash if the hash is not empty. More... | |
reset () | |
Reset the iterator instance to its initial state. More... | |
bool | valid () |
returns True if the iterator is currently pointing at a valid element, False if not More... | |
This class an iterator class for objects.
Call ObjectPairIterator::next() to iterate through the object; do not use the iterator if ObjectPairIterator::next() returns False. A object can be iterated in reverse order by calling ObjectPairIterator::prev() instead of ObjectPairIterator::next()
ITERATOR-THREAD-ERROR
to be thrown.Qore::ObjectPairIterator::constructor | ( | ) |
Creates an empty object iterator object.
Qore::ObjectPairIterator::constructor | ( | object | o | ) |
Creates the object iterator object.
o | the object to iterate |
Qore::ObjectPairIterator::copy | ( | ) |
Creates a copy of the ObjectPairIterator object, iterating the same object as the original and in the same position.
|
virtual |
returns a hash with the current key and value (a hash with 2 keys: "key"
and "value"
) or throws an INVALID-ITERATOR
exception if the iterator is invalid
"key"
and "value"
) or throws an INVALID-ITERATOR
exception if the iterator is invalidINVALID-ITERATOR | the iterator is not pointing at a valid element |
ITERATOR-THREAD-ERROR | this exception is thrown if this method is called from any thread other than the thread that created the object |
Reimplemented from Qore::HashIterator.