Qore Programming Language Reference Manual  1.4.0
QC_HashIterator.dox.h
1 namespace Qore {
4 
29 
30 public:
32 
39  constructor(hash<auto> h);
40 
41 public:
43 
50 
51 public:
53 
58  copy();
59 
60 public:
62 
73 bool empty();
74 
75 public:
77 
90 bool first();
91 
92 public:
94 
109 string getKey();
110 
111 public:
113 
130 auto getKeyValue();
131 
132 public:
134 
151 auto getValue();
152 
153 public:
155 
172 hash<auto> getValuePair();
173 
174 public:
176 
189 bool last();
190 
191 public:
193 
207 bool next();
208 
209 public:
211 
225 bool prev();
226 
227 public:
229 
238  reset();
239 
240 public:
242 
253 bool valid();
254 };
255 }
This class defines an abstract interface for bidirectional iterators where the size of the object is ...
Definition: QC_AbstractQuantifiedBidirectionalIterator.dox.h:6
This class an iterator class for hashes.
Definition: QC_HashIterator.dox.h:28
auto getKeyValue()
returns the current value of the current hash key being iterated or throws an INVALID-ITERATOR except...
bool valid()
returns True if the iterator is currently pointing at a valid element, False if not
hash< auto > getValuePair()
returns a hash with the current key and value (a hash with 2 keys: "key" and "value") or throws an IN...
bool first()
returns True if on the first element of the hash
constructor()
Creates an empty hash iterator object.
bool last()
returns True if on the last element of the hash
string getKey()
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid
constructor(hash< auto > h)
Creates the hash iterator object.
bool prev()
Moves the current position to the previous element in the hash; returns False if there are no more el...
auto getValue()
returns the current key value or throws an INVALID-ITERATOR exception if the iterator is invalid
reset()
Reset the iterator instance to its initial state.
bool empty()
returns True if the hash is empty; False if not
bool next()
Moves the current position to the next element in the hash; returns False if there are no more elemen...
copy()
Creates a copy of the HashIterator object, iterating the same object as the original and in the same ...
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3