retainAll

Common
JVM
JS
Native
1.0
fun <T> MutableCollection<out T>.retainAll(
    elements: Collection<T>
): Boolean

Retains only the elements in this collection that are contained in the specified collection.

Allows to overcome type-safety restriction of retainAll that requires to pass a collection of type Collection<E>.

Return true if any element was removed from the collection, false if the collection was not modified.

Common
JVM
JS
Native
1.0
fun <T> MutableIterable<T>.retainAll(
    predicate: (T) -> Boolean
): Boolean

Retains only elements of this MutableIterable that match the given predicate.

Common
JVM
JS
Native
1.0
fun <T> MutableList<T>.retainAll(
    predicate: (T) -> Boolean
): Boolean

Retains only elements of this MutableList that match the given predicate.

Common
JVM
JS
Native
1.0
fun <T> MutableCollection<in T>.retainAll(
    elements: Iterable<T>
): Boolean

Retains only elements of this MutableCollection that are contained in the given elements collection.

Common
JVM
JS
Native
1.0
fun <T> MutableCollection<in T>.retainAll(
    elements: Array<out T>
): Boolean

Retains only elements of this MutableCollection that are contained in the given elements array.

Common
JVM
JS
Native
1.0
fun <T> MutableCollection<in T>.retainAll(
    elements: Sequence<T>
): Boolean

Retains only elements of this MutableCollection that are contained in the given elements sequence.