interface MutableCollection<E> : Collection<E>, MutableIterable<E>
A generic collection of elements that supports adding and removing elements.
E
- the type of elements contained in the collection. The mutable collection is invariant on its element type.
abstract val size: Int Returns the size of the collection. |
abstract fun add(element: E): Boolean Adds the specified element to the collection. | |
abstract fun addAll(elements: Collection<E>): Boolean Adds all of the elements in the specified collection to this collection. | |
abstract fun clear() Removes all elements from this collection. | |
abstract fun iterator(): MutableIterator<E> Returns an iterator over the elements of this object. | |
abstract fun remove(element: E): Boolean Removes a single instance of the specified element from this collection, if it is present. | |
abstract fun removeAll(elements: Collection<E>): Boolean Removes all of this collection's elements that are also contained in the specified collection. | |
abstract fun retainAll(elements: Collection<E>): Boolean Retains only the elements in this collection that are contained in the specified collection. |
abstract fun isEmpty(): Boolean Returns |
val Collection<*>.indices: IntRange Returns an IntRange of the valid indices for this collection. |
fun <T> MutableCollection<in T>.addAll( elements: Iterable<T> ): Boolean Adds all elements of the given elements collection to this MutableCollection. fun <T> MutableCollection<in T>.addAll( elements: Sequence<T> ): Boolean Adds all elements of the given elements sequence to this MutableCollection. fun <T> MutableCollection<in T>.addAll( elements: Array<out T> ): Boolean Adds all elements of the given elements array to this MutableCollection. | |
fun <T> Iterable<T>.all(predicate: (T) -> Boolean): Boolean Returns | |
fun <T> Iterable<T>.any(): Boolean Returns fun <T> Iterable<T>.any(predicate: (T) -> Boolean): Boolean Returns | |
fun <T> Iterable<T>.asIterable(): Iterable<T> Returns this collection as an Iterable. | |
fun <T> Iterable<T>.asSequence(): Sequence<T> Creates a Sequence instance that wraps the original collection returning its elements when being iterated. | |
fun <T, K, V> Iterable<T>.associate( transform: (T) -> Pair<K, V> ): Map<K, V> Returns a Map containing key-value pairs provided by transform function applied to elements of the given collection. | |
fun <T, K> Iterable<T>.associateBy( keySelector: (T) -> K ): Map<K, T> Returns a Map containing the elements from the given collection indexed by the key returned from keySelector function applied to each element. fun <T, K, V> Iterable<T>.associateBy( keySelector: (T) -> K, valueTransform: (T) -> V ): Map<K, V> Returns a Map containing the values provided by valueTransform and indexed by keySelector functions applied to elements of the given collection. | |
fun <T, K, M : MutableMap<in K, in T>> Iterable<T>.associateByTo( destination: M, keySelector: (T) -> K ): M Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function applied to each element of the given collection and value is the element itself. fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateByTo( destination: M, keySelector: (T) -> K, valueTransform: (T) -> V ): M Populates and returns the destination mutable map with key-value pairs, where key is provided by the keySelector function and and value is provided by the valueTransform function applied to elements of the given collection. | |
fun <T, K, V, M : MutableMap<in K, in V>> Iterable<T>.associateTo( destination: M, transform: (T) -> Pair<K, V> ): M Populates and returns the destination mutable map with key-value pairs provided by transform function applied to each element of the given collection. | |
operator fun <T> Iterable<T>.contains(element: T): Boolean Returns | |
fun <T> Collection<T>.containsAll( elements: Collection<T> ): Boolean Checks if all elements in the specified collection are contained in this collection. | |
fun <T> Iterable<T>.count(predicate: (T) -> Boolean): Int Returns the number of elements matching the given predicate. | |
fun <T> Iterable<T>.distinct(): List<T> Returns a list containing only distinct elements from the given collection. | |
fun <T, K> Iterable<T>.distinctBy( selector: (T) -> K ): List<T> Returns a list containing only elements from the given collection having distinct keys returned by the given selector function. | |
fun <T> Iterable<T>.drop(n: Int): List<T> Returns a list containing all elements except first n elements. | |
fun <T> Iterable<T>.dropWhile( predicate: (T) -> Boolean ): List<T> Returns a list containing all elements except first elements that satisfy the given predicate. | |
fun <T> Iterable<T>.elementAt(index: Int): T Returns an element at the given index or throws an IndexOutOfBoundsException if the index is out of bounds of this collection. | |
fun <T> Iterable<T>.elementAtOrElse( index: Int, defaultValue: (Int) -> T ): T Returns an element at the given index or the result of calling the defaultValue function if the index is out of bounds of this collection. | |
fun <T> Iterable<T>.elementAtOrNull(index: Int): T? Returns an element at the given index or | |
fun <T> Iterable<T>.filter( predicate: (T) -> Boolean ): List<T> Returns a list containing only elements matching the given predicate. | |
fun <T> Iterable<T>.filterIndexed( predicate: (index: Int, T) -> Boolean ): List<T> Returns a list containing only elements matching the given predicate. | |
fun <T, C : MutableCollection<in T>> Iterable<T>.filterIndexedTo( destination: C, predicate: (index: Int, T) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun <R> Iterable<*>.filterIsInstance(): List<R> Returns a list containing all elements that are instances of specified type parameter R. fun <R> Iterable<*>.filterIsInstance( klass: Class<R> ): List<R> Returns a list containing all elements that are instances of specified class. | |
fun <R, C : MutableCollection<in R>> Iterable<*>.filterIsInstanceTo( destination: C ): C Appends all elements that are instances of specified type parameter R to the given destination. fun <C : MutableCollection<in R>, R> Iterable<*>.filterIsInstanceTo( destination: C, klass: Class<R> ): C Appends all elements that are instances of specified class to the given destination. | |
fun <T> Iterable<T>.filterNot( predicate: (T) -> Boolean ): List<T> Returns a list containing all elements not matching the given predicate. | |
fun <T : Any> Iterable<T?>.filterNotNull(): List<T> Returns a list containing all elements that are not | |
fun <C : MutableCollection<in T>, T : Any> Iterable<T?>.filterNotNullTo( destination: C ): C Appends all elements that are not | |
fun <T, C : MutableCollection<in T>> Iterable<T>.filterNotTo( destination: C, predicate: (T) -> Boolean ): C Appends all elements not matching the given predicate to the given destination. | |
fun <T, C : MutableCollection<in T>> Iterable<T>.filterTo( destination: C, predicate: (T) -> Boolean ): C Appends all elements matching the given predicate to the given destination. | |
fun <T> Iterable<T>.find(predicate: (T) -> Boolean): T? Returns the first element matching the given predicate, or | |
fun <T> Iterable<T>.findLast(predicate: (T) -> Boolean): T? Returns the last element matching the given predicate, or | |
fun <T> Iterable<T>.first(): T Returns first element. fun <T> Iterable<T>.first(predicate: (T) -> Boolean): T Returns the first element matching the given predicate. | |
fun <T> Iterable<T>.firstOrNull(): T? Returns the first element, or fun <T> Iterable<T>.firstOrNull( predicate: (T) -> Boolean ): T? Returns the first element matching the given predicate, or | |
fun <T, R> Iterable<T>.flatMap( transform: (T) -> Iterable<R> ): List<R> Returns a single list of all elements yielded from results of transform function being invoked on each element of original collection. | |
fun <T, R, C : MutableCollection<in R>> Iterable<T>.flatMapTo( destination: C, transform: (T) -> Iterable<R> ): C Appends all elements yielded from results of transform function being invoked on each element of original collection, to the given destination. | |
fun <T, R> Iterable<T>.fold( initial: R, operation: (acc: R, T) -> R ): R Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element. | |
fun <T, R> Iterable<T>.foldIndexed( initial: R, operation: (index: Int, acc: R, T) -> R ): R Accumulates value starting with initial value and applying operation from left to right to current accumulator value and each element with its index in the original collection. | |
fun <T> Iterable<T>.forEach(action: (T) -> Unit) Performs the given action on each element. | |
fun <T> Iterable<T>.forEachIndexed( action: (index: Int, T) -> Unit) Performs the given action on each element, providing sequential index with the element. | |
fun <T, K> Iterable<T>.groupBy( keySelector: (T) -> K ): Map<K, List<T>> Groups elements of the original collection by the key returned by the given keySelector function applied to each element and returns a map where each group key is associated with a list of corresponding elements. fun <T, K, V> Iterable<T>.groupBy( keySelector: (T) -> K, valueTransform: (T) -> V ): Map<K, List<V>> Groups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and returns a map where each group key is associated with a list of corresponding values. | |
fun <T, K, M : MutableMap<in K, MutableList<T>>> Iterable<T>.groupByTo( destination: M, keySelector: (T) -> K ): M Groups elements of the original collection by the key returned by the given keySelector function applied to each element and puts to the destination map each group key associated with a list of corresponding elements. fun <T, K, V, M : MutableMap<in K, MutableList<V>>> Iterable<T>.groupByTo( destination: M, keySelector: (T) -> K, valueTransform: (T) -> V ): M Groups values returned by the valueTransform function applied to each element of the original collection by the key returned by the given keySelector function applied to the element and puts to the destination map each group key associated with a list of corresponding values. | |
fun <T, K> Iterable<T>.groupingBy( keySelector: (T) -> K ): Grouping<T, K> Creates a Grouping source from a collection to be used later with one of group-and-fold operations using the specified keySelector function to extract a key from each element. | |
fun <T> Iterable<T>.indexOf(element: T): Int Returns first index of element, or -1 if the collection does not contain element. | |
fun <T> Iterable<T>.indexOfFirst( predicate: (T) -> Boolean ): Int Returns index of the first element matching the given predicate, or -1 if the collection does not contain such element. | |
fun <T> Iterable<T>.indexOfLast( predicate: (T) -> Boolean ): Int Returns index of the last element matching the given predicate, or -1 if the collection does not contain such element. | |
infix fun <T> Iterable<T>.intersect( other: Iterable<T> ): Set<T> Returns a set containing all elements that are contained by both this set and the specified collection. | |
fun <T> Collection<T>.isNotEmpty(): Boolean Returns | |
fun <T, A> Iterable<T>.joinTo( buffer: A, separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (T) -> CharSequence = null ): A Appends the string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun <T> Iterable<T>.joinToString( separator: CharSequence = ", ", prefix: CharSequence = "", postfix: CharSequence = "", limit: Int = -1, truncated: CharSequence = "...", transform: (T) -> CharSequence = null ): String Creates a string from all the elements separated using separator and using the given prefix and postfix if supplied. | |
fun <T> Iterable<T>.last(): T Returns the last element. fun <T> Iterable<T>.last(predicate: (T) -> Boolean): T Returns the last element matching the given predicate. | |
fun <T> Iterable<T>.lastIndexOf(element: T): Int Returns last index of element, or -1 if the collection does not contain element. | |
fun <T> Iterable<T>.lastOrNull(): T? Returns the last element, or fun <T> Iterable<T>.lastOrNull(predicate: (T) -> Boolean): T? Returns the last element matching the given predicate, or | |
fun <T, R> Iterable<T>.map(transform: (T) -> R): List<R> Returns a list containing the results of applying the given transform function to each element in the original collection. | |
fun <T, R> Iterable<T>.mapIndexed( transform: (index: Int, T) -> R ): List<R> Returns a list containing the results of applying the given transform function to each element and its index in the original collection. | |
fun <T, R : Any> Iterable<T>.mapIndexedNotNull( transform: (index: Int, T) -> R? ): List<R> Returns a list containing only the non-null results of applying the given transform function to each element and its index in the original collection. | |
fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapIndexedNotNullTo( destination: C, transform: (index: Int, T) -> R? ): C Applies the given transform function to each element and its index in the original collection and appends only the non-null results to the given destination. | |
fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapIndexedTo( destination: C, transform: (index: Int, T) -> R ): C Applies the given transform function to each element and its index in the original collection and appends the results to the given destination. | |
fun <T, R : Any> Iterable<T>.mapNotNull( transform: (T) -> R? ): List<R> Returns a list containing only the non-null results of applying the given transform function to each element in the original collection. | |
fun <T, R : Any, C : MutableCollection<in R>> Iterable<T>.mapNotNullTo( destination: C, transform: (T) -> R? ): C Applies the given transform function to each element in the original collection and appends only the non-null results to the given destination. | |
fun <T, R, C : MutableCollection<in R>> Iterable<T>.mapTo( destination: C, transform: (T) -> R ): C Applies the given transform function to each element of the original collection and appends the results to the given destination. | |
fun <T : Comparable<T>> Iterable<T>.max(): T? Returns the largest element or | |
fun <T, R : Comparable<R>> Iterable<T>.maxBy( selector: (T) -> R ): T? Returns the first element yielding the largest value of the given function or | |
fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T? fun <T> Iterable<T>.maxWith(comparator: Comparator<in T>): T? Returns the first element having the largest value according to the provided comparator or | |
fun <T : Comparable<T>> Iterable<T>.min(): T? Returns the smallest element or | |
fun <T, R : Comparable<R>> Iterable<T>.minBy( selector: (T) -> R ): T? Returns the first element yielding the smallest value of the given function or | |
fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T? fun <T> Iterable<T>.minWith(comparator: Comparator<in T>): T? Returns the first element having the smallest value according to the provided comparator or | |
operator fun <T> Iterable<T>.minus(element: T): List<T> Returns a list containing all elements of the original collection without the first occurrence of the given element. operator fun <T> Iterable<T>.minus( elements: Array<out T> ): List<T> Returns a list containing all elements of the original collection except the elements contained in the given elements array. operator fun <T> Iterable<T>.minus( elements: Iterable<T> ): List<T> Returns a list containing all elements of the original collection except the elements contained in the given elements collection. operator fun <T> Iterable<T>.minus( elements: Sequence<T> ): List<T> Returns a list containing all elements of the original collection except the elements contained in the given elements sequence. | |
operator fun <T> MutableCollection<in T>.minusAssign( element: T) Removes a single instance of the specified element from this mutable collection. operator fun <T> MutableCollection<in T>.minusAssign( elements: Iterable<T>) Removes all elements contained in the given elements collection from this mutable collection. operator fun <T> MutableCollection<in T>.minusAssign( elements: Array<T>) Removes all elements contained in the given elements array from this mutable collection. operator fun <T> MutableCollection<in T>.minusAssign( elements: Sequence<T>) Removes all elements contained in the given elements sequence from this mutable collection. | |
fun <T> Iterable<T>.minusElement(element: T): List<T> Returns a list containing all elements of the original collection without the first occurrence of the given element. | |
fun <T> Iterable<T>.none(): Boolean Returns fun <T> Iterable<T>.none(predicate: (T) -> Boolean): Boolean Returns | |
fun <T> Collection<T>?.orEmpty(): Collection<T> Returns this Collection if it's not | |
fun <T> Iterable<T>.partition( predicate: (T) -> Boolean ): Pair<List<T>, List<T>> Splits the original collection into pair of lists, where first list contains elements for which predicate yielded | |
operator fun <T> Iterable<T>.plus(element: T): List<T> operator fun <T> Collection<T>.plus(element: T): List<T> Returns a list containing all elements of the original collection and then the given element. operator fun <T> Iterable<T>.plus( elements: Array<out T> ): List<T> operator fun <T> Collection<T>.plus( elements: Array<out T> ): List<T> Returns a list containing all elements of the original collection and then all elements of the given elements array. operator fun <T> Iterable<T>.plus( elements: Iterable<T> ): List<T> operator fun <T> Collection<T>.plus( elements: Iterable<T> ): List<T> Returns a list containing all elements of the original collection and then all elements of the given elements collection. operator fun <T> Iterable<T>.plus( elements: Sequence<T> ): List<T> operator fun <T> Collection<T>.plus( elements: Sequence<T> ): List<T> Returns a list containing all elements of the original collection and then all elements of the given elements sequence. | |
operator fun <T> MutableCollection<in T>.plusAssign( element: T) Adds the specified element to this mutable collection. operator fun <T> MutableCollection<in T>.plusAssign( elements: Iterable<T>) Adds all elements of the given elements collection to this mutable collection. operator fun <T> MutableCollection<in T>.plusAssign( elements: Array<T>) Adds all elements of the given elements array to this mutable collection. operator fun <T> MutableCollection<in T>.plusAssign( elements: Sequence<T>) Adds all elements of the given elements sequence to this mutable collection. | |
fun <T> Iterable<T>.plusElement(element: T): List<T> fun <T> Collection<T>.plusElement(element: T): List<T> Returns a list containing all elements of the original collection and then the given element. | |
fun <S, T : S> Iterable<T>.reduce( operation: (acc: S, T) -> S ): S Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element. | |
fun <S, T : S> Iterable<T>.reduceIndexed( operation: (index: Int, acc: S, T) -> S ): S Accumulates value starting with the first element and applying operation from left to right to current accumulator value and each element with its index in the original collection. | |
fun <T> MutableCollection<out T>.remove(element: T): Boolean Removes a single instance of the specified element from this collection, if it is present. | |
fun <T> MutableCollection<out T>.removeAll( elements: Collection<T> ): Boolean Removes all of this collection's elements that are also contained in the specified collection. fun <T> MutableCollection<in T>.removeAll( elements: Iterable<T> ): Boolean Removes all elements from this MutableCollection that are also contained in the given elements collection. fun <T> MutableCollection<in T>.removeAll( elements: Sequence<T> ): Boolean Removes all elements from this MutableCollection that are also contained in the given elements sequence. fun <T> MutableCollection<in T>.removeAll( elements: Array<out T> ): Boolean Removes all elements from this MutableCollection that are also contained in the given elements array. fun <T> MutableIterable<T>.removeAll( predicate: (T) -> Boolean ): Boolean Removes all elements from this MutableIterable that match the given predicate. | |
fun <T : Any> Iterable<T?>.requireNoNulls(): Iterable<T> Returns an original collection containing all the non- | |
fun <T> MutableCollection<out T>.retainAll( elements: Collection<T> ): Boolean Retains only the elements in this collection that are contained in the specified collection. fun <T> MutableCollection<in T>.retainAll( elements: Iterable<T> ): Boolean Retains only elements of this MutableCollection that are contained in the given elements collection. 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. fun <T> MutableCollection<in T>.retainAll( elements: Sequence<T> ): Boolean Retains only elements of this MutableCollection that are contained in the given elements sequence. fun <T> MutableIterable<T>.retainAll( predicate: (T) -> Boolean ): Boolean Retains only elements of this MutableIterable that match the given predicate. | |
fun <T> Iterable<T>.reversed(): List<T> Returns a list with elements in reversed order. | |
fun <T> Iterable<T>.single(): T Returns the single element, or throws an exception if the collection is empty or has more than one element. fun <T> Iterable<T>.single(predicate: (T) -> Boolean): T Returns the single element matching the given predicate, or throws exception if there is no or more than one matching element. | |
fun <T> Iterable<T>.singleOrNull(): T? Returns single element, or fun <T> Iterable<T>.singleOrNull( predicate: (T) -> Boolean ): T? Returns the single element matching the given predicate, or | |
fun <T : Comparable<T>> Iterable<T>.sorted(): List<T> Returns a list of all elements sorted according to their natural sort order. | |
fun <T, R : Comparable<R>> Iterable<T>.sortedBy( selector: (T) -> R? ): List<T> Returns a list of all elements sorted according to natural sort order of the value returned by specified selector function. | |
fun <T, R : Comparable<R>> Iterable<T>.sortedByDescending( selector: (T) -> R? ): List<T> Returns a list of all elements sorted descending according to natural sort order of the value returned by specified selector function. | |
fun <T : Comparable<T>> Iterable<T>.sortedDescending(): List<T> Returns a list of all elements sorted descending according to their natural sort order. | |
fun <T> Iterable<T>.sortedWith( comparator: Comparator<in T> ): List<T> fun <T> Iterable<T>.sortedWith( comparator: Comparator<in T> ): List<T> Returns a list of all elements sorted according to the specified comparator. | |
infix fun <T> Iterable<T>.subtract( other: Iterable<T> ): Set<T> Returns a set containing all elements that are contained by this collection and not contained by the specified collection. | |
fun <T> Iterable<T>.sumBy(selector: (T) -> Int): Int Returns the sum of all values produced by selector function applied to each element in the collection. | |
fun <T> Iterable<T>.sumByDouble( selector: (T) -> Double ): Double Returns the sum of all values produced by selector function applied to each element in the collection. | |
fun <T> Iterable<T>.take(n: Int): List<T> Returns a list containing first n elements. | |
fun <T> Iterable<T>.takeWhile( predicate: (T) -> Boolean ): List<T> Returns a list containing first elements satisfying the given predicate. | |
fun <T, C : MutableCollection<in T>> Iterable<T>.toCollection( destination: C ): C Appends all elements to the given destination collection. | |
fun <T> Iterable<T>.toHashSet(): HashSet<T> Returns a HashSet of all elements. | |
fun <T> Iterable<T>.toList(): List<T> Returns a List containing all elements. | |
fun <T> Iterable<T>.toMutableSet(): MutableSet<T> Returns a mutable set containing all distinct elements from the given collection. | |
fun <T> Iterable<T>.toSet(): Set<T> Returns a Set of all elements. | |
fun <T : Comparable<T>> Iterable<T>.toSortedSet(): SortedSet<T> fun <T> Iterable<T>.toSortedSet( comparator: Comparator<in T> ): SortedSet<T> Returns a SortedSet of all elements. | |
fun <T> Collection<T>.toTypedArray(): Array<T> Returns a typed array containing all of the elements of this collection. | |
infix fun <T> Iterable<T>.union(other: Iterable<T>): Set<T> Returns a set containing all distinct elements from both collections. | |
fun <T> Iterable<T>.withIndex(): Iterable<IndexedValue<T>> Returns a lazy Iterable of IndexedValue for each element of the original collection. | |
infix fun <T, R> Iterable<T>.zip( other: Array<out R> ): List<Pair<T, R>> infix fun <T, R> Iterable<T>.zip( other: Iterable<R> ): List<Pair<T, R>> Returns a list of pairs built from elements of both collections with same indexes. List has length of shortest collection. fun <T, R, V> Iterable<T>.zip( other: Array<out R>, transform: (a: T, b: R) -> V ): List<V> fun <T, R, V> Iterable<T>.zip( other: Iterable<R>, transform: (a: T, b: R) -> V ): List<V> Returns a list of values built from elements of both collections with same indexes using provided transform. List has length of shortest collection. |
abstract class AbstractMutableCollection<E> : MutableCollection<E>, AbstractCollection<E> Provides a skeletal implementation of the MutableCollection interface. | |
interface MutableList<E> : List<E>, MutableCollection<E> A generic ordered collection of elements that supports adding and removing elements. | |
interface MutableSet<E> : Set<E>, MutableCollection<E> A generic unordered collection of elements that does not support duplicate elements, and supports adding and removing elements. |
© 2010–2017 JetBrains s.r.o.
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-collection/