![]() |
Qore Programming Language Reference Manual 2.1.1
|
This class an iterator class for hashes. More...
#include <QC_HashKeyIterator.dox.h>
Public Member Functions | |
| constructor (hash< auto > h) | |
| Creates the hash iterator object. | |
| constructor () | |
| Creates an empty hash iterator object. | |
| copy () | |
| Creates a copy of the HashKeyIterator object, iterating the same object as the original and in the same position. | |
| string | getValue () |
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid | |
Public Member Functions inherited from Qore::HashIterator | |
| constructor (hash< auto > h) | |
| Creates the hash iterator object. | |
| constructor () | |
| Creates an empty hash iterator object. | |
| copy () | |
| Creates a copy of the HashIterator object, iterating the same object as the original and in the same position. | |
| bool | empty () |
| returns True if the hash is empty; False if not | |
| bool | first () |
| returns True if on the first element of the hash | |
| string | getKey () |
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid | |
| auto | getKeyValue () |
returns the current value of the current hash key being iterated or throws an INVALID-ITERATOR exception if the iterator is invalid | |
| auto | getValue () |
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid | |
| 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 | |
| bool | last () |
| returns True if on the last element of the hash | |
| 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. | |
| 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. | |
| reset () | |
| Reset the iterator instance to its initial state. | |
| bool | valid () |
| returns True if the iterator is currently pointing at a valid element, False if not | |
Public Member Functions inherited from Qore::AbstractBidirectionalIterator | |
| abstract bool | prev () |
| Moves the current position to the previous element; returns False if there are no more elements. | |
Public Member Functions inherited from Qore::AbstractIterator | |
| abstract auto | getValue () |
| returns the current value | |
| abstract bool | next () |
| Moves the current position to the next element; returns False if there are no more elements. | |
| abstract bool | valid () |
| returns True if the iterator is currently pointing at a valid element, False if not | |
Public Member Functions inherited from Qore::AbstractQuantifiedIterator | |
| abstract bool | empty () |
| returns True if the object to iterate is empty; False if not | |
| abstract bool | first () |
| returns True if on the first element | |
| abstract bool | last () |
| returns True if on the last element | |
This class an iterator class for hashes.
Call HashKeyIterator::next() to iterate through the hash; do not use the iterator if HashKeyIterator::next() returns False. A hash can be iterated in reverse order by calling HashKeyIterator::prev() instead of HashKeyIterator::next()
ITERATOR-THREAD-ERROR to be thrown.| Qore::HashKeyIterator::constructor | ( | ) |
Creates an empty hash iterator object.
| Qore::HashKeyIterator::constructor | ( | hash< auto > | h | ) |
Creates the hash iterator object.
| h | the hash to iterate |
| Qore::HashKeyIterator::copy | ( | ) |
Creates a copy of the HashKeyIterator object, iterating the same object as the original and in the same position.
| string Qore::HashKeyIterator::getValue | ( | ) |
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid
INVALID-ITERATOR exception if the iterator is invalid| INVALID-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 |