AbstractIterator

Common
JVM
JS
Native
1.0
abstract class AbstractIterator<T> : Iterator<T>

A base class to simplify implementing iterators so that implementations only have to implement computeNext to implement the iterator, calling done when the iteration is complete.

Constructors

Common
JVM
JS
Native
1.0

<init>

A base class to simplify implementing iterators so that implementations only have to implement computeNext to implement the iterator, calling done when the iteration is complete.

AbstractIterator()

Functions

Common
JVM
JS
Native
1.0

computeNext

Computes the next item in the iterator.

abstract fun computeNext()
Common
JVM
JS
Native
1.0

done

Sets the state to done so that the iteration terminates.

fun done()
Common
JVM
JS
Native
1.0

hasNext

Returns true if the iteration has more elements.

open fun hasNext(): Boolean
Common
JVM
JS
Native
1.0

next

Returns the next element in the iteration.

open fun next(): T
Common
JVM
JS
Native
1.0

setNext

Sets the next value in the iteration, called from the computeNext function

fun setNext(value: T)

Extension Functions

Common
JVM
JS
Native
1.0

asSequence

Creates a sequence that returns all elements from this iterator. The sequence is constrained to be iterated only once.

fun <T> Iterator<T>.asSequence(): Sequence<T>
Common
JVM
JS
Native
1.0

forEach

Performs the given operation on each element of this Iterator.

fun <T> Iterator<T>.forEach(operation: (T) -> Unit)
Common
JVM
JS
Native
1.0

iterator

Returns the given iterator itself. This allows to use an instance of iterator in a for loop.

operator fun <T> Iterator<T>.iterator(): Iterator<T>
Common
JVM
JS
Native
1.0

withIndex

Returns an Iterator wrapping each value produced by this Iterator with the IndexedValue, containing value and it's index.

fun <T> Iterator<T>.withIndex(): Iterator<IndexedValue<T>>