MutableListIterator

Platform and version requirements: JVM (1.0), JS (1.1), Native (1.3)
interface MutableListIterator<T> : 
    ListIterator<T>, 
    MutableIterator<T>

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

Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

add

Adds the specified element element into the underlying collection immediately before the element that would be returned by next, if any, and after the element that would be returned by previous, if any. (If the collection contains no elements, the new element becomes the sole element in the collection.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

abstract fun add(element: T)
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

hasNext

Returns true if the iteration has more elements.

abstract fun hasNext(): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

next

Returns the next element in the iteration.

abstract fun next(): T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

remove

Removes from the underlying collection the last element returned by this iterator.

abstract fun remove()
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

set

Replaces the last element returned by next or previous with the specified element element.

abstract fun set(element: T)

Extension Functions

Platform and version requirements: JVM (1.0), JS (1.0), 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>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

forEach

Performs the given operation on each element of this Iterator.

fun <T> Iterator<T>.forEach(operation: (T) -> Unit)
Platform and version requirements: JVM (1.0), JS (1.0), 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>
Platform and version requirements: JVM (1.0), JS (1.0), 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>>

© 2010–2021 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list-iterator/index.html