Iterator
An iterator over a collection or another entity that can be represented as a sequence of elements. Allows to sequentially access the elements.
Functions
hasNext
Returns
true
if the iteration has more elements.
abstract
operator
fun
hasNext
(
)
:
Boolean
next
Returns the next element in the iteration.
abstract
operator
fun
next
(
)
:
T
Extension Functions
withIndex
Returns an Iterator that wraps each element produced by the original iterator into an IndexedValue containing the index of that element and the element itself.
fun
<
T
>
Iterator
<
T
>
.
withIndex
(
)
:
Iterator
<
IndexedValue
<
T
>
>
Inheritors
AbstractIterator
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.
abstract
class
AbstractIterator
<
T
>
:
Iterator
<
T
>
BooleanIterator
An iterator over a sequence of values of type
Boolean
.
abstract
class
BooleanIterator
:
Iterator
<
Boolean
>
ByteIterator
An iterator over a sequence of values of type
Byte
.
abstract
class
ByteIterator
:
Iterator
<
Byte
>
CharIterator
An iterator over a sequence of values of type
Char
.
abstract
class
CharIterator
:
Iterator
<
Char
>
DoubleIterator
An iterator over a sequence of values of type
Double
.
abstract
class
DoubleIterator
:
Iterator
<
Double
>
FloatIterator
An iterator over a sequence of values of type
Float
.
abstract
class
FloatIterator
:
Iterator
<
Float
>
IntIterator
An iterator over a sequence of values of type
Int
.
abstract
class
IntIterator
:
Iterator
<
Int
>
ListIterator
An iterator over a collection that supports indexed access.
interface
ListIterator
<
out
T
>
:
Iterator
<
T
>
LongIterator
An iterator over a sequence of values of type
Long
.
abstract
class
LongIterator
:
Iterator
<
Long
>
MutableIterator
An iterator over a mutable collection. Provides the ability to remove elements while iterating.
interface
MutableIterator
<
out
T
>
:
Iterator
<
T
>
ShortIterator
An iterator over a sequence of values of type
Short
.
abstract
class
ShortIterator
:
Iterator
<
Short
>