smjg.libs.util.hashmap.THashMap< K, V >.MapIterator Class Reference

The MapIterator class is used to iterate over the elements of a HashMap. More...

List of all members.

Public Member Functions
	this (Map m)
void	opPostInc ()
	Advances the iterator.
bool	atEnd ()
	Checks whether the end of the map has been reached.
Properties
K	key ()
	The key associated with the iterator's current position.
V	value ()
	The value associated with the iterator's current position.
V	value (V v)
	The value associated with the iterator's current position.

---

Detailed Description

The MapIterator class is used to iterate over the elements of a HashMap.

Modifying the map, other than by the iterator's value property, and then continuing to use the iterator, currently leads to undefined behaviour.

---

Constructor & Destructor Documentation

smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.this

(

Map

m

)

Constructs a new iterator over a given map.

Parameters:

m

Map to iterate over.

---

Member Function Documentation

K smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.key

(

)

The key associated with the iterator's current position.

Precondition:

The iterator must not be at the end.

V smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.value

(

)

The value associated with the iterator's current position.

Precondition:

The iterator must not be at the end.

V smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.value

(

V

v

)

The value associated with the iterator's current position.

Precondition:

The iterator must not be at the end.

void smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.opPostInc

(

)

Advances the iterator.

(Implementation of this++.)

bool smjg.libs.util.hashmap.THashMap< K, V >.MapIterator.atEnd

(

)

Checks whether the end of the map has been reached.

This occurs when this++ has been called after the iterator has visited every entry in the map.

Return values:

	true	if the iterator is at the end.
	false	if the iterator is not at the end, i.e. the key and value properties are still valid.

---

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

• hashmap.d

---