RWConstIterator

Module:  Essential Tools Module   Group:  RWCollectable Classes

• Local Index
• Synopsis
• Description
• Persistence
• Public Virtual Functions

Members

findNext()

key()

operator()()

reset()

#include <rw/iterator.h>
typedef RWConstIterator Iterator;  //Smalltalk typedef: deprecated.

Class RWConstIterator is an abstract base class for const iterators used by the Smalltalk-like collection classes. The const iterators do not change any information in the data structure upon which they iterate.

The class contains virtual functions for positioning and resetting the iterator. They are all pure virtual functions, meaning that deriving classes must supply a definition. The descriptions below are intended to be generic -- all inheriting iterators generally follow the described pattern.

None

virtual const RWCollectable*
findNext(const RWCollectable* target) = 0;

Moves the iterator forward to the next item which "matches" the object pointed to by target and returns it or nil if no item was found. For most collections, an item "matches" the target if either isEqual() or compareTo() indicates equivalence, which ever is appropriate for the actual collection type. However, when an iterator is used with an "identity collection" (i.e., RWIdentitySet and RWIdentityDictionary), it looks for an item with the same address (i.e., "is identical to").

virtual const RWCollectable*
key() const = 0;

Returns the item at the current iterator position.

virtual const RWCollectable*
operator()() = 0;

Advances the iterator and returns the next item, or nil if the end of the collection has been reached.

virtual void
reset() = 0; 

Resets the iterator to the state it had immediately after construction.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.