Iterator

Iteratorclass

Superclass
Tree Subclass
Tree Global
Objects Property
Summary Method
Summary Property
Details Method
Details

The native iterator type - this is the base class for all iterators. This class is abstract and is thus never directly instantiated.

Note that iterators can never be created directly with the 'new' operator. Instead, iterators must be obtained from a collection via the collection's createIterator() method.

intrinsic class Iterator : Object

Superclass Tree (in declaration order)

Iterator
Object

Subclass Tree

Iterator
IndexedIterator
LookupTableIterator

Global Objects

(none)

Summary of Properties

(none)

Summary of Methods

getCurKey getCurVal getNext isNextAvailable resetIterator

Inherited from Object :
getPropList getPropParams getSuperclassList isClass isTransient ofKind propDefined propInherited propType valToSymbol

Properties

(none)

Methods

getCurKey ( ) systype.h[204]

Get the current key. This returns the value of the key for the current item in the collection. For an indexed collection, this returns the index value; for a keyed collection, this returns the current key value.

getCurVal ( ) systype.h[210]

Get the current value. This returns the value of the current item in the collection.

getNext ( ) systype.h[183]

Get the next item in the collection. This returns the next item's value, and advances the internal state in the iterator so that a subsequent call to getNext() returns the next item after this one. When the iterator is first created, or after calling resetIterator(), this returns the first item in the collection.

isNextAvailable ( ) systype.h[190]

Determine if the collection is out of items. Returns true if getNext() will return a valid item, nil if no more items are available.

resetIterator ( ) systype.h[196]

Reset to the first item. After calling this routine, the next call to getNext() will return the first item in the collection.

TADS 3 Library Manual
Generated on 5/16/2013 from TADS version 3.1.3