ListIterator

Common
JVM
JS
Native
1.0
interface ListIterator<out T> : Iterator<T>
(Common source) (Native source)

An iterator over a collection that supports indexed access.

See Also

List.listIterator

Functions

Common
JVM
JS
Native
1.0

hasNext

Returns true if the iteration has more elements.

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

hasPrevious

Returns true if there are elements in the iteration before the current element.

abstract fun hasPrevious(): Boolean
Common
JVM
JS
Native
1.0

next

Returns the next element in the iteration.

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

nextIndex

Returns the index of the element that would be returned by a subsequent call to next.

abstract fun nextIndex(): Int
Common
JVM
JS
Native
1.0

previous

Returns the previous element in the iteration and moves the cursor position backwards.

abstract fun previous(): T
Common
JVM
JS
Native
1.0

previousIndex

Returns the index of the element that would be returned by a subsequent call to previous.

abstract fun previousIndex(): Int

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 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

Common
JVM
JS
Native
1.0

MutableListIterator

An iterator over a mutable collection that supports indexed access. Provides the ability to add, modify and remove elements while iterating.

interface MutableListIterator<T> : 
    ListIterator<T>,
    MutableIterator<T>