Added in API level 1

Collections

open class Collections

kotlin.Any
↳	java.util.Collections

This class consists exclusively of static methods that operate on or return collections. It contains polymorphic algorithms that operate on collections, "wrappers", which return a new collection backed by a specified collection, and a few other odds and ends.

The methods of this class all throw a NullPointerException if the collections or class objects provided to them are null.

The documentation for the polymorphic algorithms contained in this class generally includes a brief description of the implementation. Such descriptions should be regarded as implementation notes, rather than parts of the specification. Implementors should feel free to substitute other algorithms, so long as the specification itself is adhered to. (For example, the algorithm used by sort does not have to be a mergesort, but it does have to be stable.)

The "destructive" algorithms contained in this class, that is, the algorithms that modify the collection on which they operate, are specified to throw UnsupportedOperationException if the collection does not support the appropriate mutation primitive(s), such as the set method. These algorithms may, but are not required to, throw this exception if an invocation would have no effect on the collection. For example, invoking the sort method on an unmodifiable list that is already sorted may or may not throw UnsupportedOperationException.

This class is a member of the Java Collections Framework.

Summary

Public methods
open static Boolean	addAll(c: MutableCollection<in T>, vararg elements: T) Adds all of the specified elements to the specified collection.
open static Queue<T>	asLifoQueue(deque: Deque<T>) Returns a view of a Deque as a Last-in-first-out (Lifo) Queue.
open static Int	binarySearch(list: MutableList<out Comparable<T>!>, key: T) Searches the specified list for the specified object using the binary search algorithm.
open static Int	binarySearch(list: MutableList<out T>, key: T, c: Comparator<in T>?) Searches the specified list for the specified object using the binary search algorithm.
open static MutableCollection<E>	checkedCollection(c: MutableCollection<E>, type: Class<E>) Returns a dynamically typesafe view of the specified collection.
open static MutableList<E>	checkedList(list: MutableList<E>, type: Class<E>) Returns a dynamically typesafe view of the specified list.
open static MutableMap<K, V>	checkedMap(m: MutableMap<K, V>, keyType: Class<K>, valueType: Class<V>) Returns a dynamically typesafe view of the specified map.
open static NavigableMap<K, V>	checkedNavigableMap(m: NavigableMap<K, V>, keyType: Class<K>, valueType: Class<V>) Returns a dynamically typesafe view of the specified navigable map.
open static NavigableSet<E>	checkedNavigableSet(s: NavigableSet<E>, type: Class<E>) Returns a dynamically typesafe view of the specified navigable set.
open static Queue<E>	checkedQueue(queue: Queue<E>, type: Class<E>) Returns a dynamically typesafe view of the specified queue.
open static MutableSet<E>	checkedSet(s: MutableSet<E>, type: Class<E>) Returns a dynamically typesafe view of the specified set.
open static SortedMap<K, V>	checkedSortedMap(m: SortedMap<K, V>, keyType: Class<K>, valueType: Class<V>) Returns a dynamically typesafe view of the specified sorted map.
open static SortedSet<E>	checkedSortedSet(s: SortedSet<E>, type: Class<E>) Returns a dynamically typesafe view of the specified sorted set.
open static Unit	copy(dest: MutableList<in T>, src: MutableList<out T>) Copies all of the elements from one list into another.
open static Boolean	disjoint(c1: MutableCollection<*>, c2: MutableCollection<*>) Returns true if the two specified collections have no elements in common.
open static Enumeration<T>	emptyEnumeration() Returns an enumeration that has no elements.
open static MutableIterator<T>	emptyIterator() Returns an iterator that has no elements.
static MutableList<T>	emptyList() Returns an empty list (immutable).
open static MutableListIterator<T>	emptyListIterator() Returns a list iterator that has no elements.
static MutableMap<K, V>	emptyMap() Returns an empty map (immutable).
static NavigableMap<K, V>	emptyNavigableMap() Returns an empty navigable map (immutable).
open static NavigableSet<E>	emptyNavigableSet() Returns an empty navigable set (immutable).
static MutableSet<T>	emptySet() Returns an empty set (immutable).
static SortedMap<K, V>	emptySortedMap() Returns an empty sorted map (immutable).
open static SortedSet<E>	emptySortedSet() Returns an empty sorted set (immutable).
open static Enumeration<T>	enumeration(c: MutableCollection<T>) Returns an enumeration over the specified collection.
open static Unit	fill(list: MutableList<in T>, obj: T) Replaces all of the elements of the specified list with the specified element.
open static Int	frequency(c: MutableCollection<*>, o: Any?) Returns the number of elements in the specified collection equal to the specified object.
open static Int	indexOfSubList(source: MutableList<*>, target: MutableList<*>) Returns the starting position of the first occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence.
open static Int	lastIndexOfSubList(source: MutableList<*>, target: MutableList<*>) Returns the starting position of the last occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence.
open static ArrayList<T>	list(e: Enumeration<T>) Returns an array list containing the elements returned by the specified enumeration in the order they are returned by the enumeration.
open static T	max(coll: MutableCollection<out T>) Returns the maximum element of the given collection, according to the natural ordering of its elements.
open static T	max(coll: MutableCollection<out T>, comp: Comparator<in T>?) Returns the maximum element of the given collection, according to the order induced by the specified comparator.
open static T	min(coll: MutableCollection<out T>) Returns the minimum element of the given collection, according to the natural ordering of its elements.
open static T	min(coll: MutableCollection<out T>, comp: Comparator<in T>?) Returns the minimum element of the given collection, according to the order induced by the specified comparator.
open static MutableList<T>	nCopies(n: Int, o: T) Returns an immutable list consisting of n copies of the specified object.
open static SequencedSet<E>	newSequencedSetFromMap(map: SequencedMap<E, Boolean!>) Returns a sequenced set backed by the specified map.
open static MutableSet<E>	newSetFromMap(map: MutableMap<E, Boolean!>) Returns a set backed by the specified map.
open static Boolean	replaceAll(list: MutableList<T>, oldVal: T, newVal: T) Replaces all occurrences of one specified value in a list with another.
open static Unit	reverse(list: MutableList<*>) Reverses the order of the elements in the specified list.
open static Comparator<T>	reverseOrder() Returns a comparator that imposes the reverse of the natural ordering on a collection of objects that implement the Comparable interface.
open static Comparator<T>	reverseOrder(cmp: Comparator<T>?) Returns a comparator that imposes the reverse ordering of the specified comparator.
open static Unit	rotate(list: MutableList<*>, distance: Int) Rotates the elements in the specified list by the specified distance.
open static Unit	shuffle(list: MutableList<*>) Randomly permutes the specified list using a default source of randomness.
open static Unit	shuffle(list: MutableList<*>, rnd: Random) Randomly permute the specified list using the specified source of randomness.
open static Unit	shuffle(list: MutableList<*>, rnd: RandomGenerator) Randomly permute the specified list using the specified source of randomness.
open static MutableSet<T>	singleton(o: T) Returns an immutable set containing only the specified object.
open static MutableList<T>	singletonList(o: T) Returns an immutable list containing only the specified object.
open static MutableMap<K, V>	singletonMap(key: K, value: V) Returns an immutable map, mapping only the specified key to the specified value.
open static Unit	sort(list: MutableList<T>) Sorts the specified list into ascending order, according to the natural ordering of its elements.
open static Unit	sort(list: MutableList<T>, c: Comparator<in T>?) Sorts the specified list according to the order induced by the specified comparator.
open static Unit	swap(list: MutableList<*>, i: Int, j: Int) Swaps the elements at the specified positions in the specified list.
open static MutableCollection<T>	synchronizedCollection(c: MutableCollection<T>) Returns a synchronized (thread-safe) collection backed by the specified collection.
open static MutableList<T>	synchronizedList(list: MutableList<T>) Returns a synchronized (thread-safe) list backed by the specified list.
open static MutableMap<K, V>	synchronizedMap(m: MutableMap<K, V>) Returns a synchronized (thread-safe) map backed by the specified map.
open static NavigableMap<K, V>	synchronizedNavigableMap(m: NavigableMap<K, V>) Returns a synchronized (thread-safe) navigable map backed by the specified navigable map.
open static NavigableSet<T>	synchronizedNavigableSet(s: NavigableSet<T>) Returns a synchronized (thread-safe) navigable set backed by the specified navigable set.
open static MutableSet<T>	synchronizedSet(s: MutableSet<T>) Returns a synchronized (thread-safe) set backed by the specified set.
open static SortedMap<K, V>	synchronizedSortedMap(m: SortedMap<K, V>) Returns a synchronized (thread-safe) sorted map backed by the specified sorted map.
open static SortedSet<T>	synchronizedSortedSet(s: SortedSet<T>) Returns a synchronized (thread-safe) sorted set backed by the specified sorted set.
open static MutableCollection<T>	unmodifiableCollection(c: MutableCollection<out T>) Returns an unmodifiable view of the specified collection.
open static MutableList<T>	unmodifiableList(list: MutableList<out T>) Returns an unmodifiable view of the specified list.
open static MutableMap<K, V>	unmodifiableMap(m: MutableMap<out K, out V>) Returns an unmodifiable view of the specified map.
open static NavigableMap<K, V>	unmodifiableNavigableMap(m: NavigableMap<K, out V>) Returns an unmodifiable view of the specified navigable map.
open static NavigableSet<T>	unmodifiableNavigableSet(s: NavigableSet<T>) Returns an unmodifiable view of the specified navigable set.
open static SequencedCollection<T>	unmodifiableSequencedCollection(c: SequencedCollection<out T>) Returns an unmodifiable view of the specified SequencedCollection.
open static SequencedMap<K, V>	unmodifiableSequencedMap(m: SequencedMap<out K, out V>) Returns an unmodifiable view of the specified SequencedMap.
open static SequencedSet<T>	unmodifiableSequencedSet(s: SequencedSet<out T>) Returns an unmodifiable view of the specified SequencedSet.
open static MutableSet<T>	unmodifiableSet(s: MutableSet<out T>) Returns an unmodifiable view of the specified set.
open static SortedMap<K, V>	unmodifiableSortedMap(m: SortedMap<K, out V>) Returns an unmodifiable view of the specified sorted map.
open static SortedSet<T>	unmodifiableSortedSet(s: SortedSet<T>) Returns an unmodifiable view of the specified sorted set.

Properties
static MutableList<Any?>	EMPTY_LIST The empty list (immutable).
static MutableMap<Any?, Any?>	EMPTY_MAP The empty map (immutable).
static MutableSet<Any?>	EMPTY_SET The empty set (immutable).

Public methods

addAll

Added in API level 1

@SafeVarargs open static fun <T : Any!> addAll(
    c: MutableCollection<in T>, 
    vararg elements: T
): Boolean

Adds all of the specified elements to the specified collection. Elements to be added may be specified individually or as an array. The behaviour of this convenience method is similar to that of c.addAll(Collections.unmodifiableList(Arrays.asList(elements))).

When elements are specified individually, this method provides a convenient way to add a few elements to an existing collection:

Collections.addAll(flavors, "Peaches 'n Plutonium", "Rocky Racoon");
  

Parameters
<T>	the class of the elements to add and of the collection
c	MutableCollection<in T>: the collection into which elements are to be inserted
elements	T: the elements to insert into c

Return
Boolean	true if the collection changed as a result of the call

Exceptions
java.lang.UnsupportedOperationException	if c does not support the add operation
java.lang.NullPointerException	if elements contains one or more null values and c does not permit null elements, or if c or elements are null
java.lang.IllegalArgumentException	if some property of a value in elements prevents it from being added to c

See Also

• java.util.Collection#addAll(Collection)

asLifoQueue

Added in API level 9

open static fun <T : Any!> asLifoQueue(deque: Deque<T>): Queue<T>

Returns a view of a Deque as a Last-in-first-out (Lifo) Queue. Method add is mapped to push, remove is mapped to pop and so on. This view can be useful when you would like to use a method requiring a Queue but you need Lifo ordering.

Each method invocation on the queue returned by this method results in exactly one method invocation on the backing deque, with one exception. The addAll method is implemented as a sequence of addFirst invocations on the backing deque.

Parameters
<T>	the class of the objects in the deque
deque	Deque<T>: the deque

Return
Queue<T>	the queue

binarySearch

Added in API level 1

open static fun <T : Any!> binarySearch(
    list: MutableList<out Comparable<T>!>, 
    key: T
): Int

Searches the specified list for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the natural ordering of its elements (as by the sort(java.util.List) method) prior to making this call. If it is not sorted, the results are undefined. If the list contains multiple elements equal to the specified object, there is no guarantee which one will be found.

This method runs in log(n) time for a "random access" list (which provides near-constant-time positional access). If the specified list does not implement the RandomAccess interface and is large, this method will do an iterator-based binary search that performs O(n) link traversals and O(log n) element comparisons.

Parameters
<T>	the class of the objects in the list
list	MutableList<out Comparable<T>!>: the list to be searched.
key	T: the key to be searched for.

Return

Int

the index of the search key, if it is contained in the list; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the list: the index of the first element greater than the key, or list.size() if all elements in the list are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

Exceptions
java.lang.ClassCastException	if the list contains elements that are not mutually comparable (for example, strings and integers), or the search key is not mutually comparable with the elements of the list.

binarySearch

Added in API level 1

open static fun <T : Any!> binarySearch(
    list: MutableList<out T>, 
    key: T, 
    c: Comparator<in T>?
): Int

Searches the specified list for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator (as by the sort(List, Comparator) method), prior to making this call. If it is not sorted, the results are undefined. If the list contains multiple elements equal to the specified object, there is no guarantee which one will be found.

This method runs in log(n) time for a "random access" list (which provides near-constant-time positional access). If the specified list does not implement the RandomAccess interface and is large, this method will do an iterator-based binary search that performs O(n) link traversals and O(log n) element comparisons.

Parameters
<T>	the class of the objects in the list
list	MutableList<out T>: the list to be searched.
key	T: the key to be searched for.
c	Comparator<in T>?: the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.

Return

Int

the index of the search key, if it is contained in the list; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the list: the index of the first element greater than the key, or list.size() if all elements in the list are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

Exceptions
java.lang.ClassCastException	if the list contains elements that are not mutually comparable using the specified comparator, or the search key is not mutually comparable with the elements of the list using this comparator.

checkedCollection

Added in API level 1

open static fun <E : Any!> checkedCollection(
    c: MutableCollection<E>, 
    type: Class<E>
): MutableCollection<E>

Returns a dynamically typesafe view of the specified collection. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a collection contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the collection takes place through the view, it is guaranteed that the collection cannot contain an incorrectly typed element.

The generics mechanism in the language provides compile-time (static) type checking, but it is possible to defeat this mechanism with unchecked casts. Usually this is not a problem, as the compiler issues warnings on all such unchecked operations. There are, however, times when static type checking alone is not sufficient. For example, suppose a collection is passed to a third-party library and it is imperative that the library code not corrupt the collection by inserting an element of the wrong type.

Another use of dynamically typesafe views is debugging. Suppose a program fails with a ClassCastException, indicating that an incorrectly typed element was put into a parameterized collection. Unfortunately, the exception can occur at any time after the erroneous element is inserted, so it typically provides little or no information as to the real source of the problem. If the problem is reproducible, one can quickly determine its source by temporarily modifying the program to wrap the collection with a dynamically typesafe view. For example, this declaration:

<code>Collection&lt;String&gt; c = new HashSet&lt;&gt;();
  </code>

may be replaced temporarily by this one:

<code>Collection&lt;String&gt; c = Collections.checkedCollection(
          new HashSet&lt;&gt;(), String.class);
  </code>

Running the program again will cause it to fail at the point where an incorrectly typed element is inserted into the collection, clearly identifying the source of the problem. Once the problem is fixed, the modified declaration may be reverted back to the original.

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if the specified collection is serializable.

Since null is considered to be a value of any reference type, the returned collection permits insertion of null elements whenever the backing collection does.

Parameters
<E>	the class of the objects in the collection
c	MutableCollection<E>: the collection for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that c is permitted to hold

Return
MutableCollection<E>	a dynamically typesafe view of the specified collection

checkedList

Added in API level 1

open static fun <E : Any!> checkedList(
    list: MutableList<E>, 
    type: Class<E>
): MutableList<E>

Returns a dynamically typesafe view of the specified list. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a list contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the list takes place through the view, it is guaranteed that the list cannot contain an incorrectly typed element.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned list will be serializable if the specified list is serializable.

Since null is considered to be a value of any reference type, the returned list permits insertion of null elements whenever the backing list does.

Parameters
<E>	the class of the objects in the list
list	MutableList<E>: the list for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that list is permitted to hold

Return
MutableList<E>	a dynamically typesafe view of the specified list

checkedMap

Added in API level 1

open static fun <K : Any!, V : Any!> checkedMap(
    m: MutableMap<K, V>, 
    keyType: Class<K>, 
    valueType: Class<V>
): MutableMap<K, V>

Returns a dynamically typesafe view of the specified map. Any attempt to insert a mapping whose key or value have the wrong type will result in an immediate ClassCastException. Similarly, any attempt to modify the value currently associated with a key will result in an immediate ClassCastException, whether the modification is attempted directly through the map itself, or through a Map.Entry instance obtained from the map's entry set view.

Assuming a map contains no incorrectly typed keys or values prior to the time a dynamically typesafe view is generated, and that all subsequent access to the map takes place through the view (or one of its collection views), it is guaranteed that the map cannot contain an incorrectly typed key or value.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned map will be serializable if the specified map is serializable.

Since null is considered to be a value of any reference type, the returned map permits insertion of null keys or values whenever the backing map does.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	MutableMap<K, V>: the map for which a dynamically typesafe view is to be returned
keyType	Class<K>: the type of key that m is permitted to hold
valueType	Class<V>: the type of value that m is permitted to hold

Return
MutableMap<K, V>	a dynamically typesafe view of the specified map

checkedNavigableMap

Added in API level 26

open static fun <K : Any!, V : Any!> checkedNavigableMap(
    m: NavigableMap<K, V>, 
    keyType: Class<K>, 
    valueType: Class<V>
): NavigableMap<K, V>

Returns a dynamically typesafe view of the specified navigable map. Any attempt to insert a mapping whose key or value have the wrong type will result in an immediate ClassCastException. Similarly, any attempt to modify the value currently associated with a key will result in an immediate ClassCastException, whether the modification is attempted directly through the map itself, or through a Map.Entry instance obtained from the map's entry set view.

Assuming a map contains no incorrectly typed keys or values prior to the time a dynamically typesafe view is generated, and that all subsequent access to the map takes place through the view (or one of its collection views), it is guaranteed that the map cannot contain an incorrectly typed key or value.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned map will be serializable if the specified map is serializable.

Since null is considered to be a value of any reference type, the returned map permits insertion of null keys or values whenever the backing map does.

Parameters
<K>	type of map keys
<V>	type of map values
m	NavigableMap<K, V>: the map for which a dynamically typesafe view is to be returned
keyType	Class<K>: the type of key that m is permitted to hold
valueType	Class<V>: the type of value that m is permitted to hold

Return
NavigableMap<K, V>	a dynamically typesafe view of the specified map

checkedNavigableSet

Added in API level 26

open static fun <E : Any!> checkedNavigableSet(
    s: NavigableSet<E>, 
    type: Class<E>
): NavigableSet<E>

Returns a dynamically typesafe view of the specified navigable set. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a navigable set contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the navigable set takes place through the view, it is guaranteed that the navigable set cannot contain an incorrectly typed element.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned navigable set will be serializable if the specified navigable set is serializable.

Since null is considered to be a value of any reference type, the returned navigable set permits insertion of null elements whenever the backing sorted set does.

Parameters
<E>	the class of the objects in the set
s	NavigableSet<E>: the navigable set for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that s is permitted to hold

Return
NavigableSet<E>	a dynamically typesafe view of the specified navigable set

checkedQueue

Added in API level 26

open static fun <E : Any!> checkedQueue(
    queue: Queue<E>, 
    type: Class<E>
): Queue<E>

Returns a dynamically typesafe view of the specified queue. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a queue contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the queue takes place through the view, it is guaranteed that the queue cannot contain an incorrectly typed element.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned queue will be serializable if the specified queue is serializable.

Since null is considered to be a value of any reference type, the returned queue permits insertion of null elements whenever the backing queue does.

Parameters
<E>	the class of the objects in the queue
queue	Queue<E>: the queue for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that queue is permitted to hold

Return
Queue<E>	a dynamically typesafe view of the specified queue

checkedSet

Added in API level 1

open static fun <E : Any!> checkedSet(
    s: MutableSet<E>, 
    type: Class<E>
): MutableSet<E>

Returns a dynamically typesafe view of the specified set. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a set contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the set takes place through the view, it is guaranteed that the set cannot contain an incorrectly typed element.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned set will be serializable if the specified set is serializable.

Since null is considered to be a value of any reference type, the returned set permits insertion of null elements whenever the backing set does.

Parameters
<E>	the class of the objects in the set
s	MutableSet<E>: the set for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that s is permitted to hold

Return
MutableSet<E>	a dynamically typesafe view of the specified set

checkedSortedMap

Added in API level 1

open static fun <K : Any!, V : Any!> checkedSortedMap(
    m: SortedMap<K, V>, 
    keyType: Class<K>, 
    valueType: Class<V>
): SortedMap<K, V>

Returns a dynamically typesafe view of the specified sorted map. Any attempt to insert a mapping whose key or value have the wrong type will result in an immediate ClassCastException. Similarly, any attempt to modify the value currently associated with a key will result in an immediate ClassCastException, whether the modification is attempted directly through the map itself, or through a Map.Entry instance obtained from the map's entry set view.

Assuming a map contains no incorrectly typed keys or values prior to the time a dynamically typesafe view is generated, and that all subsequent access to the map takes place through the view (or one of its collection views), it is guaranteed that the map cannot contain an incorrectly typed key or value.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned map will be serializable if the specified map is serializable.

Since null is considered to be a value of any reference type, the returned map permits insertion of null keys or values whenever the backing map does.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	SortedMap<K, V>: the map for which a dynamically typesafe view is to be returned
keyType	Class<K>: the type of key that m is permitted to hold
valueType	Class<V>: the type of value that m is permitted to hold

Return
SortedMap<K, V>	a dynamically typesafe view of the specified map

checkedSortedSet

Added in API level 1

open static fun <E : Any!> checkedSortedSet(
    s: SortedSet<E>, 
    type: Class<E>
): SortedSet<E>

Returns a dynamically typesafe view of the specified sorted set. Any attempt to insert an element of the wrong type will result in an immediate ClassCastException. Assuming a sorted set contains no incorrectly typed elements prior to the time a dynamically typesafe view is generated, and that all subsequent access to the sorted set takes place through the view, it is guaranteed that the sorted set cannot contain an incorrectly typed element.

A discussion of the use of dynamically typesafe views may be found in the documentation for the checkedCollection method.

The returned sorted set will be serializable if the specified sorted set is serializable.

Since null is considered to be a value of any reference type, the returned sorted set permits insertion of null elements whenever the backing sorted set does.

Parameters
<E>	the class of the objects in the set
s	SortedSet<E>: the sorted set for which a dynamically typesafe view is to be returned
type	Class<E>: the type of element that s is permitted to hold

Return
SortedSet<E>	a dynamically typesafe view of the specified sorted set

copy

Added in API level 1

open static fun <T : Any!> copy(
    dest: MutableList<in T>, 
    src: MutableList<out T>
): Unit

Copies all of the elements from one list into another. After the operation, the index of each copied element in the destination list will be identical to its index in the source list. The destination list's size must be greater than or equal to the source list's size. If it is greater, the remaining elements in the destination list are unaffected.

This method runs in linear time.

Parameters
<T>	the class of the objects in the lists
dest	MutableList<in T>: The destination list.
src	MutableList<out T>: The source list.

Exceptions
java.lang.IndexOutOfBoundsException	if the destination list is too small to contain the entire source List.
java.lang.UnsupportedOperationException	if the destination list's list-iterator does not support the set operation.

disjoint

Added in API level 1

open static fun disjoint(
    c1: MutableCollection<*>, 
    c2: MutableCollection<*>
): Boolean

Returns true if the two specified collections have no elements in common.

Care must be exercised if this method is used on collections that do not comply with the general contract for Collection. Implementations may elect to iterate over either collection and test for containment in the other collection (or to perform any equivalent computation). If either collection uses a nonstandard equality test (as does a SortedSet whose ordering is not compatible with equals, or the key set of an IdentityHashMap), both collections must use the same nonstandard equality test, or the result of this method is undefined.

Care must also be exercised when using collections that have restrictions on the elements that they may contain. Collection implementations are allowed to throw exceptions for any operation involving elements they deem ineligible. For absolute safety the specified collections should contain only elements which are eligible elements for both collections.

Note that it is permissible to pass the same collection in both parameters, in which case the method will return true if and only if the collection is empty.

Parameters
c1	MutableCollection<*>: a collection
c2	MutableCollection<*>: a collection

Return
Boolean	true if the two specified collections have no elements in common.

Exceptions
java.lang.NullPointerException	if one collection contains a null element and null is not an eligible element for the other collection. (optional)
java.lang.ClassCastException	if one collection contains an element that is of a type which is ineligible for the other collection. (optional)

emptyEnumeration

Added in API level 19

open static fun <T : Any!> emptyEnumeration(): Enumeration<T>

Returns an enumeration that has no elements. More precisely,

• hasMoreElements always returns false.
• nextElement always throws NoSuchElementException.

Implementations of this method are permitted, but not required, to return the same object from multiple invocations.

Parameters
<T>	the class of the objects in the enumeration

Return
Enumeration<T>	an empty enumeration

emptyIterator

Added in API level 19

open static fun <T : Any!> emptyIterator(): MutableIterator<T>

Returns an iterator that has no elements. More precisely,

• hasNext always returns false.
• next always throws NoSuchElementException.
• remove always throws IllegalStateException.

Implementations of this method are permitted, but not required, to return the same object from multiple invocations.

Parameters
<T>	type of elements, if there were any, in the iterator

Return
MutableIterator<T>	an empty iterator

emptyList

Added in API level 1

static fun <T : Any!> emptyList(): MutableList<T>

Returns an empty list (immutable). This list is serializable.

This example illustrates the type-safe way to obtain an empty list:

List<String> s = Collections.emptyList();
  

Parameters
<T>	type of elements, if there were any, in the list

Return
MutableList<T>	an empty immutable list

See Also

• #EMPTY_LIST

emptyListIterator

Added in API level 19

open static fun <T : Any!> emptyListIterator(): MutableListIterator<T>

Returns a list iterator that has no elements. More precisely,

• hasNext and hasPrevious always return false.
• next and previous always throw NoSuchElementException.
• remove and set always throw IllegalStateException.
• add always throws UnsupportedOperationException.
• nextIndex always returns 0.
• previousIndex always returns -1.

Implementations of this method are permitted, but not required, to return the same object from multiple invocations.

Parameters
<T>	type of elements, if there were any, in the iterator

Return
MutableListIterator<T>	an empty list iterator

emptyMap

Added in API level 1

static fun <K : Any!, V : Any!> emptyMap(): MutableMap<K, V>

Returns an empty map (immutable). This map is serializable.

This example illustrates the type-safe way to obtain an empty map:

Map<String, Date> s = Collections.emptyMap();
  

Parameters
<K>	the class of the map keys
<V>	the class of the map values

Return
MutableMap<K, V>	an empty map

See Also

• #EMPTY_MAP

emptyNavigableMap

Added in API level 26

static fun <K : Any!, V : Any!> emptyNavigableMap(): NavigableMap<K, V>

Returns an empty navigable map (immutable). This map is serializable.

This example illustrates the type-safe way to obtain an empty map:

<code>NavigableMap&lt;String, Date&gt; s = Collections.emptyNavigableMap();
  </code>

Parameters
<K>	the class of the map keys
<V>	the class of the map values

Return
NavigableMap<K, V>	an empty navigable map

emptyNavigableSet

Added in API level 26

open static fun <E : Any!> emptyNavigableSet(): NavigableSet<E>

Returns an empty navigable set (immutable). This set is serializable.

This example illustrates the type-safe way to obtain an empty navigable set:

<code>NavigableSet&lt;String&gt; s = Collections.emptyNavigableSet();
  </code>

Parameters
<E>	type of elements, if there were any, in the set

Return
NavigableSet<E>	the empty navigable set

emptySet

Added in API level 1

static fun <T : Any!> emptySet(): MutableSet<T>

Returns an empty set (immutable). This set is serializable. Unlike the like-named field, this method is parameterized.

This example illustrates the type-safe way to obtain an empty set:

Set<String> s = Collections.emptySet();
  

Parameters
<T>	the class of the objects in the set

Return
MutableSet<T>	the empty set

See Also

• #EMPTY_SET

emptySortedMap

Added in API level 26

static fun <K : Any!, V : Any!> emptySortedMap(): SortedMap<K, V>

Returns an empty sorted map (immutable). This map is serializable.

This example illustrates the type-safe way to obtain an empty map:

<code>SortedMap&lt;String, Date&gt; s = Collections.emptySortedMap();
  </code>

Parameters
<K>	the class of the map keys
<V>	the class of the map values

Return
SortedMap<K, V>	an empty sorted map

emptySortedSet

Added in API level 26

open static fun <E : Any!> emptySortedSet(): SortedSet<E>

Returns an empty sorted set (immutable). This set is serializable.

This example illustrates the type-safe way to obtain an empty sorted set:

<code>SortedSet&lt;String&gt; s = Collections.emptySortedSet();
  </code>

Parameters
<E>	type of elements, if there were any, in the set

Return
SortedSet<E>	the empty sorted set

enumeration

Added in API level 1

open static fun <T : Any!> enumeration(c: MutableCollection<T>): Enumeration<T>

Returns an enumeration over the specified collection. This provides interoperability with legacy APIs that require an enumeration as input.

The iterator returned from a call to Enumeration#asIterator() does not support removal of elements from the specified collection. This is necessary to avoid unintentionally increasing the capabilities of the returned enumeration.

Parameters
<T>	the class of the objects in the collection
c	MutableCollection<T>: the collection for which an enumeration is to be returned.

Return
Enumeration<T>	an enumeration over the specified collection.

See Also

• java.util.Enumeration

fill

Added in API level 1

open static fun <T : Any!> fill(
    list: MutableList<in T>, 
    obj: T
): Unit

Replaces all of the elements of the specified list with the specified element.

This method runs in linear time.

Parameters
<T>	the class of the objects in the list
list	MutableList<in T>: the list to be filled with the specified element.
obj	T: The element with which to fill the specified list.

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

frequency

Added in API level 1

open static fun frequency(
    c: MutableCollection<*>, 
    o: Any?
): Int

Returns the number of elements in the specified collection equal to the specified object. More formally, returns the number of elements e in the collection such that Objects.equals(o, e).

Parameters
c	MutableCollection<*>: the collection in which to determine the frequency of o
o	Any?: the object whose frequency is to be determined

Return
Int	the number of elements in c equal to o

Exceptions
java.lang.NullPointerException	if c is null

indexOfSubList

Added in API level 1

open static fun indexOfSubList(
    source: MutableList<*>, 
    target: MutableList<*>
): Int

Returns the starting position of the first occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence. More formally, returns the lowest index i such that source.subList(i, i+target.size()).equals(target), or -1 if there is no such index. (Returns -1 if target.size() > source.size())

This implementation uses the "brute force" technique of scanning over the source list, looking for a match with the target at each location in turn.

Parameters
source	MutableList<*>: the list in which to search for the first occurrence of target.
target	MutableList<*>: the list to search for as a subList of source.

Return
Int	the starting position of the first occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence.

lastIndexOfSubList

Added in API level 1

open static fun lastIndexOfSubList(
    source: MutableList<*>, 
    target: MutableList<*>
): Int

Returns the starting position of the last occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence. More formally, returns the highest index i such that source.subList(i, i+target.size()).equals(target), or -1 if there is no such index. (Returns -1 if target.size() > source.size())

This implementation uses the "brute force" technique of iterating over the source list, looking for a match with the target at each location in turn.

Parameters
source	MutableList<*>: the list in which to search for the last occurrence of target.
target	MutableList<*>: the list to search for as a subList of source.

Return
Int	the starting position of the last occurrence of the specified target list within the specified source list, or -1 if there is no such occurrence.

list

Added in API level 1

open static fun <T : Any!> list(e: Enumeration<T>): ArrayList<T>

Returns an array list containing the elements returned by the specified enumeration in the order they are returned by the enumeration. This method provides interoperability between legacy APIs that return enumerations and new APIs that require collections.

Parameters
<T>	the class of the objects returned by the enumeration
e	Enumeration<T>: enumeration providing elements for the returned array list

Return
ArrayList<T>	an array list containing the elements returned by the specified enumeration.

See Also

• java.util.Enumeration
• java.util.ArrayList

max

Added in API level 1

open static fun <T> max(coll: MutableCollection<out T>): T where T : Any!, T : Comparable<T>!

Returns the maximum element of the given collection, according to the natural ordering of its elements. All elements in the collection must implement the Comparable interface. Furthermore, all elements in the collection must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the collection).

This method iterates over the entire collection, hence it requires time proportional to the size of the collection.

Parameters
<T>	the class of the objects in the collection
coll	MutableCollection<out T>: the collection whose maximum element is to be determined.

Return
T	the maximum element of the given collection, according to the natural ordering of its elements.

Exceptions
java.lang.ClassCastException	if the collection contains elements that are not mutually comparable (for example, strings and integers).
java.util.NoSuchElementException	if the collection is empty.

See Also

• java.lang.Comparable

max

Added in API level 1

open static fun <T : Any!> max(
    coll: MutableCollection<out T>, 
    comp: Comparator<in T>?
): T

Returns the maximum element of the given collection, according to the order induced by the specified comparator. All elements in the collection must be mutually comparable by the specified comparator (that is, comp.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the collection).

This method iterates over the entire collection, hence it requires time proportional to the size of the collection.

Parameters
<T>	the class of the objects in the collection
coll	MutableCollection<out T>: the collection whose maximum element is to be determined.
comp	Comparator<in T>?: the comparator with which to determine the maximum element. A null value indicates that the elements' natural ordering should be used.

Return
T	the maximum element of the given collection, according to the specified comparator.

Exceptions
java.lang.ClassCastException	if the collection contains elements that are not mutually comparable using the specified comparator.
java.util.NoSuchElementException	if the collection is empty.

See Also

• java.lang.Comparable

min

Added in API level 1

open static fun <T> min(coll: MutableCollection<out T>): T where T : Any!, T : Comparable<T>!

Returns the minimum element of the given collection, according to the natural ordering of its elements. All elements in the collection must implement the Comparable interface. Furthermore, all elements in the collection must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the collection).

This method iterates over the entire collection, hence it requires time proportional to the size of the collection.

Parameters
<T>	the class of the objects in the collection
coll	MutableCollection<out T>: the collection whose minimum element is to be determined.

Return
T	the minimum element of the given collection, according to the natural ordering of its elements.

Exceptions
java.lang.ClassCastException	if the collection contains elements that are not mutually comparable (for example, strings and integers).
java.util.NoSuchElementException	if the collection is empty.

See Also

• java.lang.Comparable

min

Added in API level 1

open static fun <T : Any!> min(
    coll: MutableCollection<out T>, 
    comp: Comparator<in T>?
): T

Returns the minimum element of the given collection, according to the order induced by the specified comparator. All elements in the collection must be mutually comparable by the specified comparator (that is, comp.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the collection).

This method iterates over the entire collection, hence it requires time proportional to the size of the collection.

Parameters
<T>	the class of the objects in the collection
coll	MutableCollection<out T>: the collection whose minimum element is to be determined.
comp	Comparator<in T>?: the comparator with which to determine the minimum element. A null value indicates that the elements' natural ordering should be used.

Return
T	the minimum element of the given collection, according to the specified comparator.

Exceptions
java.lang.ClassCastException	if the collection contains elements that are not mutually comparable using the specified comparator.
java.util.NoSuchElementException	if the collection is empty.

See Also

• java.lang.Comparable

nCopies

Added in API level 1

open static fun <T : Any!> nCopies(
    n: Int, 
    o: T
): MutableList<T>

Returns an immutable list consisting of n copies of the specified object. The newly allocated data object is tiny (it contains a single reference to the data object). This method is useful in combination with the List.addAll method to grow lists. The returned list is serializable.

Parameters
<T>	the class of the object to copy and of the objects in the returned list.
n	Int: the number of elements in the returned list.
o	T: the element to appear repeatedly in the returned list.

Return
MutableList<T>	an immutable list consisting of n copies of the specified object.

Exceptions
java.lang.IllegalArgumentException	if n < 0

See Also

• java.util.List#addAll(Collection)
• java.util.List#addAll(int, Collection)

newSequencedSetFromMap

Added in API level 35

open static fun <E : Any!> newSequencedSetFromMap(map: SequencedMap<E, Boolean!>): SequencedSet<E>

Returns a sequenced set backed by the specified map. The resulting set displays the same ordering, concurrency, and performance characteristics as the backing map. In essence, this factory method provides a SequencedSet implementation corresponding to any SequencedMap implementation.

Each method invocation on the set returned by this method results in exactly one method invocation on the backing map or its keySet view, with one exception. The addAll method is implemented as a sequence of put invocations on the backing map.

The specified map must be empty at the time this method is invoked, and should not be accessed directly after this method returns. These conditions are ensured if the map is created empty, passed directly to this method, and no reference to the map is retained.

Parameters
<E>	the class of the map keys and of the objects in the returned set
map	SequencedMap<E, Boolean!>: the backing map

Return
SequencedSet<E>	the set backed by the map

Exceptions
java.lang.IllegalArgumentException	if map is not empty

newSetFromMap

Added in API level 9

open static fun <E : Any!> newSetFromMap(map: MutableMap<E, Boolean!>): MutableSet<E>

Returns a set backed by the specified map. The resulting set displays the same ordering, concurrency, and performance characteristics as the backing map. In essence, this factory method provides a Set implementation corresponding to any Map implementation. There is no need to use this method on a Map implementation that already has a corresponding Set implementation (such as HashMap or TreeMap).

Each method invocation on the set returned by this method results in exactly one method invocation on the backing map or its keySet view, with one exception. The addAll method is implemented as a sequence of put invocations on the backing map.

The specified map must be empty at the time this method is invoked, and should not be accessed directly after this method returns. These conditions are ensured if the map is created empty, passed directly to this method, and no reference to the map is retained, as illustrated in the following code fragment:

Set<Object> weakHashSet = Collections.newSetFromMap(
         new WeakHashMap<Object, Boolean>());
  

Parameters
<E>	the class of the map keys and of the objects in the returned set
map	MutableMap<E, Boolean!>: the backing map

Return
MutableSet<E>	the set backed by the map

Exceptions
java.lang.IllegalArgumentException	if map is not empty

replaceAll

Added in API level 1

open static fun <T : Any!> replaceAll(
    list: MutableList<T>, 
    oldVal: T, 
    newVal: T
): Boolean

Replaces all occurrences of one specified value in a list with another. More formally, replaces with newVal each element e in list such that (oldVal==null ? e==null : oldVal.equals(e)). (This method has no effect on the size of the list.)

Parameters
<T>	the class of the objects in the list
list	MutableList<T>: the list in which replacement is to occur.
oldVal	T: the old value to be replaced.
newVal	T: the new value with which oldVal is to be replaced.

Return
Boolean	true if list contained one or more elements e such that (oldVal==null ? e==null : oldVal.equals(e)).

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

reverse

Added in API level 1

open static fun reverse(list: MutableList<*>): Unit

Reverses the order of the elements in the specified list.

This method runs in linear time.

Parameters
list	MutableList<*>: the list whose elements are to be reversed.

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

See Also

• java.util.List#reversed

reverseOrder

Added in API level 1

open static fun <T : Any!> reverseOrder(): Comparator<T>

Returns a comparator that imposes the reverse of the natural ordering on a collection of objects that implement the Comparable interface. (The natural ordering is the ordering imposed by the objects' own compareTo method.) This enables a simple idiom for sorting (or maintaining) collections (or arrays) of objects that implement the Comparable interface in reverse-natural-order. For example, suppose a is an array of strings. Then:

Arrays.sort(a, Collections.reverseOrder());
  

sorts the array in reverse-lexicographic (alphabetical) order.

The returned comparator is serializable.

Parameters
<T>	the class of the objects compared by the comparator

Return
Comparator<T>	A comparator that imposes the reverse of the natural ordering on a collection of objects that implement the Comparable interface.

See Also

• java.lang.Comparable

reverseOrder

Added in API level 1

open static fun <T : Any!> reverseOrder(cmp: Comparator<T>?): Comparator<T>

Returns a comparator that imposes the reverse ordering of the specified comparator. If the specified comparator is null, this method is equivalent to reverseOrder() (in other words, it returns a comparator that imposes the reverse of the natural ordering on a collection of objects that implement the Comparable interface).

The returned comparator is serializable (assuming the specified comparator is also serializable or null).

Parameters
<T>	the class of the objects compared by the comparator
cmp	Comparator<T>?: a comparator who's ordering is to be reversed by the returned comparator or null

Return
Comparator<T>	A comparator that imposes the reverse ordering of the specified comparator.

rotate

Added in API level 1

open static fun rotate(
    list: MutableList<*>, 
    distance: Int
): Unit

Rotates the elements in the specified list by the specified distance. After calling this method, the element at index i will be the element previously at index (i - distance) mod list.size(), for all values of i between 0 and list.size()-1, inclusive. (This method has no effect on the size of the list.)

For example, suppose list comprises[t, a, n, k, s]. After invoking Collections.rotate(list, 1) (or Collections.rotate(list, -4)), list will comprise [s, t, a, n, k].

Note that this method can usefully be applied to sublists to move one or more elements within a list while preserving the order of the remaining elements. For example, the following idiom moves the element at index j forward to position k (which must be greater than or equal to j):

Collections.rotate(list.subList(j, k+1), -1);
  

To make this concrete, suppose list comprises [a, b, c, d, e]. To move the element at index 1 (b) forward two positions, perform the following invocation:

Collections.rotate(l.subList(1, 4), -1);
  

The resulting list is [a, c, d, b, e].

To move more than one element forward, increase the absolute value of the rotation distance. To move elements backward, use a positive shift distance.

If the specified list is small or implements the RandomAccess interface, this implementation exchanges the first element into the location it should go, and then repeatedly exchanges the displaced element into the location it should go until a displaced element is swapped into the first element. If necessary, the process is repeated on the second and successive elements, until the rotation is complete. If the specified list is large and doesn't implement the RandomAccess interface, this implementation breaks the list into two sublist views around index -distance mod size. Then the reverse(java.util.List) method is invoked on each sublist view, and finally it is invoked on the entire list. For a more complete description of both algorithms, see Section 2.3 of Jon Bentley's Programming Pearls (Addison-Wesley, 1986).

Parameters
list	MutableList<*>: the list to be rotated.
distance	Int: the distance to rotate the list. There are no constraints on this value; it may be zero, negative, or greater than list.size().

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

shuffle

Added in API level 1

open static fun shuffle(list: MutableList<*>): Unit

Randomly permutes the specified list using a default source of randomness. All permutations occur with approximately equal likelihood.

The hedge "approximately" is used in the foregoing description because default source of randomness is only approximately an unbiased source of independently chosen bits. If it were a perfect source of randomly chosen bits, then the algorithm would choose permutations with perfect uniformity.

This implementation traverses the list backwards, from the last element up to the second, repeatedly swapping a randomly selected element into the "current position". Elements are randomly selected from the portion of the list that runs from the first element to the current position, inclusive.

Parameters
list	MutableList<*>: the list to be shuffled.

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

shuffle

Added in API level 1

open static fun shuffle(
    list: MutableList<*>, 
    rnd: Random
): Unit

Randomly permute the specified list using the specified source of randomness.

This method is equivalent to shuffle(java.util.List,java.util.random.RandomGenerator) and exists for backward compatibility. The shuffle(java.util.List,java.util.random.RandomGenerator) method is preferred, as it is not limited to random generators that extend the Random class.

Parameters
list	MutableList<*>: the list to be shuffled.
rnd	Random: the source of randomness to use to shuffle the list.

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

shuffle

Added in API level 35

open static fun shuffle(
    list: MutableList<*>, 
    rnd: RandomGenerator
): Unit

Randomly permute the specified list using the specified source of randomness. All permutations occur with equal likelihood assuming that the source of randomness is fair.

This implementation traverses the list backwards, from the last element up to the second, repeatedly swapping a randomly selected element into the "current position". Elements are randomly selected from the portion of the list that runs from the first element to the current position, inclusive.

Parameters
list	MutableList<*>: the list to be shuffled.
rnd	RandomGenerator: the source of randomness to use to shuffle the list.

Exceptions
java.lang.UnsupportedOperationException	if the specified list or its list-iterator does not support the set operation.

singleton

Added in API level 1

open static fun <T : Any!> singleton(o: T): MutableSet<T>

Returns an immutable set containing only the specified object. The returned set is serializable.

Parameters
<T>	the class of the objects in the set
o	T: the sole object to be stored in the returned set.

Return
MutableSet<T>	an immutable set containing only the specified object.

singletonList

Added in API level 1

open static fun <T : Any!> singletonList(o: T): MutableList<T>

Returns an immutable list containing only the specified object. The returned list is serializable.

Parameters
<T>	the class of the objects in the list
o	T: the sole object to be stored in the returned list.

Return
MutableList<T>	an immutable list containing only the specified object.

singletonMap

Added in API level 1

open static fun <K : Any!, V : Any!> singletonMap(
    key: K, 
    value: V
): MutableMap<K, V>

Returns an immutable map, mapping only the specified key to the specified value. The returned map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
key	K: the sole key to be stored in the returned map.
value	V: the value to which the returned map maps key.

Return
MutableMap<K, V>	an immutable map containing only the specified key-value mapping.

sort

Added in API level 1

open static fun <T : Comparable<T>!> sort(list: MutableList<T>): Unit

Sorts the specified list into ascending order, according to the natural ordering of its elements. All elements in the list must implement the Comparable interface. Furthermore, all elements in the list must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the list).

This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.

The specified list must be modifiable, but need not be resizable.

Parameters
<T>	the class of the objects in the list
list	MutableList<T>: the list to be sorted.

Exceptions
java.lang.ClassCastException	if the list contains elements that are not mutually comparable (for example, strings and integers).
java.lang.UnsupportedOperationException	if the specified list's list-iterator does not support the set operation.
java.lang.IllegalArgumentException	(optional) if the implementation detects that the natural ordering of the list elements is found to violate the Comparable contract

See Also

• java.util.List#sort(Comparator)

sort

Added in API level 1

open static fun <T : Any!> sort(
    list: MutableList<T>, 
    c: Comparator<in T>?
): Unit

Sorts the specified list according to the order induced by the specified comparator. All elements in the list must be mutually comparable using the specified comparator (that is, c.compare(e1, e2) must not throw a ClassCastException for any elements e1 and e2 in the list).

This sort is guaranteed to be stable: equal elements will not be reordered as a result of the sort.

The specified list must be modifiable, but need not be resizable.

Parameters
<T>	the class of the objects in the list
list	MutableList<T>: the list to be sorted.
c	Comparator<in T>?: the comparator to determine the order of the list. A null value indicates that the elements' natural ordering should be used.

Exceptions
java.lang.ClassCastException	if the list contains elements that are not mutually comparable using the specified comparator.
java.lang.UnsupportedOperationException	if the specified list's list-iterator does not support the set operation.
java.lang.IllegalArgumentException	(optional) if the comparator is found to violate the Comparator contract

See Also

• java.util.List#sort(Comparator)

swap

Added in API level 1

open static fun swap(
    list: MutableList<*>, 
    i: Int, 
    j: Int
): Unit

Swaps the elements at the specified positions in the specified list. (If the specified positions are equal, invoking this method leaves the list unchanged.)

Parameters
list	MutableList<*>: The list in which to swap elements.
i	Int: the index of one element to be swapped.
j	Int: the index of the other element to be swapped.

Exceptions
java.lang.IndexOutOfBoundsException	if either i or j is out of range (i < 0 || i >= list.size() || j < 0 || j >= list.size()).

synchronizedCollection

Added in API level 1

open static fun <T : Any!> synchronizedCollection(c: MutableCollection<T>): MutableCollection<T>

Returns a synchronized (thread-safe) collection backed by the specified collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.

It is imperative that the user manually synchronize on the returned collection when traversing it via Iterator, Spliterator or Stream:

Collection c = Collections.synchronizedCollection(myCollection);
      ...
   synchronized (c) {
       Iterator i = c.iterator(); // Must be in the synchronized block
       while (i.hasNext())
          foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if the specified collection is serializable.

Parameters
<T>	the class of the objects in the collection
c	MutableCollection<T>: the collection to be "wrapped" in a synchronized collection.

Return
MutableCollection<T>	a synchronized view of the specified collection.

synchronizedList

Added in API level 1

open static fun <T : Any!> synchronizedList(list: MutableList<T>): MutableList<T>

Returns a synchronized (thread-safe) list backed by the specified list. In order to guarantee serial access, it is critical that all access to the backing list is accomplished through the returned list.

It is imperative that the user manually synchronize on the returned list when traversing it via Iterator, Spliterator or Stream:

List list = Collections.synchronizedList(new ArrayList());
       ...
   synchronized (list) {
       Iterator i = list.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned list will be serializable if the specified list is serializable.

Parameters
<T>	the class of the objects in the list
list	MutableList<T>: the list to be "wrapped" in a synchronized list.

Return
MutableList<T>	a synchronized view of the specified list.

synchronizedMap

Added in API level 1

open static fun <K : Any!, V : Any!> synchronizedMap(m: MutableMap<K, V>): MutableMap<K, V>

Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.

It is imperative that the user manually synchronize on the returned map when traversing any of its collection views via Iterator, Spliterator or Stream:

Map m = Collections.synchronizedMap(new HashMap());
       ...
   Set s = m.keySet();  // Needn't be in synchronized block
       ...
   synchronized (m) {  // Synchronizing on m, not s!
       Iterator i = s.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned map will be serializable if the specified map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	MutableMap<K, V>: the map to be "wrapped" in a synchronized map.

Return
MutableMap<K, V>	a synchronized view of the specified map.

synchronizedNavigableMap

Added in API level 26

open static fun <K : Any!, V : Any!> synchronizedNavigableMap(m: NavigableMap<K, V>): NavigableMap<K, V>

Returns a synchronized (thread-safe) navigable map backed by the specified navigable map. In order to guarantee serial access, it is critical that all access to the backing navigable map is accomplished through the returned navigable map (or its views).

It is imperative that the user manually synchronize on the returned navigable map when traversing any of its collection views, or the collections views of any of its subMap, headMap or tailMap views, via Iterator, Spliterator or Stream:

NavigableMap m = Collections.synchronizedNavigableMap(new TreeMap());
       ...
   Set s = m.keySet();  // Needn't be in synchronized block
       ...
   synchronized (m) {  // Synchronizing on m, not s!
       Iterator i = s.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

or:

NavigableMap m = Collections.synchronizedNavigableMap(new TreeMap());
   NavigableMap m2 = m.subMap(foo, true, bar, false);
       ...
   Set s2 = m2.keySet();  // Needn't be in synchronized block
       ...
   synchronized (m) {  // Synchronizing on m, not m2 or s2!
       Iterator i = s2.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned navigable map will be serializable if the specified navigable map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	NavigableMap<K, V>: the navigable map to be "wrapped" in a synchronized navigable map

Return
NavigableMap<K, V>	a synchronized view of the specified navigable map.

synchronizedNavigableSet

Added in API level 26

open static fun <T : Any!> synchronizedNavigableSet(s: NavigableSet<T>): NavigableSet<T>

Returns a synchronized (thread-safe) navigable set backed by the specified navigable set. In order to guarantee serial access, it is critical that all access to the backing navigable set is accomplished through the returned navigable set (or its views).

It is imperative that the user manually synchronize on the returned navigable set when traversing it, or any of its subSet, headSet, or tailSet views, via Iterator, Spliterator or Stream:

NavigableSet s = Collections.synchronizedNavigableSet(new TreeSet());
       ...
   synchronized (s) {
       Iterator i = s.iterator(); // Must be in the synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

or:

NavigableSet s = Collections.synchronizedNavigableSet(new TreeSet());
   NavigableSet s2 = s.headSet(foo, true);
       ...
   synchronized (s) {  // Note: s, not s2!!!
       Iterator i = s2.iterator(); // Must be in the synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned navigable set will be serializable if the specified navigable set is serializable.

Parameters
<T>	the class of the objects in the set
s	NavigableSet<T>: the navigable set to be "wrapped" in a synchronized navigable set

Return
NavigableSet<T>	a synchronized view of the specified navigable set

synchronizedSet

Added in API level 1

open static fun <T : Any!> synchronizedSet(s: MutableSet<T>): MutableSet<T>

Returns a synchronized (thread-safe) set backed by the specified set. In order to guarantee serial access, it is critical that all access to the backing set is accomplished through the returned set.

It is imperative that the user manually synchronize on the returned collection when traversing it via Iterator, Spliterator or Stream:

Set s = Collections.synchronizedSet(new HashSet());
       ...
   synchronized (s) {
       Iterator i = s.iterator(); // Must be in the synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned set will be serializable if the specified set is serializable.

Parameters
<T>	the class of the objects in the set
s	MutableSet<T>: the set to be "wrapped" in a synchronized set.

Return
MutableSet<T>	a synchronized view of the specified set.

synchronizedSortedMap

Added in API level 1

open static fun <K : Any!, V : Any!> synchronizedSortedMap(m: SortedMap<K, V>): SortedMap<K, V>

Returns a synchronized (thread-safe) sorted map backed by the specified sorted map. In order to guarantee serial access, it is critical that all access to the backing sorted map is accomplished through the returned sorted map (or its views).

It is imperative that the user manually synchronize on the returned sorted map when traversing any of its collection views, or the collections views of any of its subMap, headMap or tailMap views, via Iterator, Spliterator or Stream:

SortedMap m = Collections.synchronizedSortedMap(new TreeMap());
       ...
   Set s = m.keySet();  // Needn't be in synchronized block
       ...
   synchronized (m) {  // Synchronizing on m, not s!
       Iterator i = s.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

or:

SortedMap m = Collections.synchronizedSortedMap(new TreeMap());
   SortedMap m2 = m.subMap(foo, bar);
       ...
   Set s2 = m2.keySet();  // Needn't be in synchronized block
       ...
   synchronized (m) {  // Synchronizing on m, not m2 or s2!
       Iterator i = s2.iterator(); // Must be in synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned sorted map will be serializable if the specified sorted map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	SortedMap<K, V>: the sorted map to be "wrapped" in a synchronized sorted map.

Return
SortedMap<K, V>	a synchronized view of the specified sorted map.

synchronizedSortedSet

Added in API level 1

open static fun <T : Any!> synchronizedSortedSet(s: SortedSet<T>): SortedSet<T>

Returns a synchronized (thread-safe) sorted set backed by the specified sorted set. In order to guarantee serial access, it is critical that all access to the backing sorted set is accomplished through the returned sorted set (or its views).

It is imperative that the user manually synchronize on the returned sorted set when traversing it or any of its subSet, headSet, or tailSet views via Iterator, Spliterator or Stream:

SortedSet s = Collections.synchronizedSortedSet(new TreeSet());
       ...
   synchronized (s) {
       Iterator i = s.iterator(); // Must be in the synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

or:

SortedSet s = Collections.synchronizedSortedSet(new TreeSet());
   SortedSet s2 = s.headSet(foo);
       ...
   synchronized (s) {  // Note: s, not s2!!!
       Iterator i = s2.iterator(); // Must be in the synchronized block
       while (i.hasNext())
           foo(i.next());
   }
  

Failure to follow this advice may result in non-deterministic behavior.

The returned sorted set will be serializable if the specified sorted set is serializable.

Parameters
<T>	the class of the objects in the set
s	SortedSet<T>: the sorted set to be "wrapped" in a synchronized sorted set.

Return
SortedSet<T>	a synchronized view of the specified sorted set.

unmodifiableCollection

Added in API level 1

open static fun <T : Any!> unmodifiableCollection(c: MutableCollection<out T>): MutableCollection<T>

Returns an unmodifiable view of the specified collection. Query operations on the returned collection "read through" to the specified collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if the specified collection is serializable.

Parameters
<T>	the class of the objects in the collection
c	MutableCollection<out T>: the collection for which an unmodifiable view is to be returned.

Return
MutableCollection<T>	an unmodifiable view of the specified collection.

unmodifiableList

Added in API level 1

open static fun <T : Any!> unmodifiableList(list: MutableList<out T>): MutableList<T>

Returns an unmodifiable view of the specified list. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned list will be serializable if the specified list is serializable. Similarly, the returned list will implement RandomAccess if the specified list does.

Parameters
<T>	the class of the objects in the list
list	MutableList<out T>: the list for which an unmodifiable view is to be returned.

Return
MutableList<T>	an unmodifiable view of the specified list.

unmodifiableMap

Added in API level 1

open static fun <K : Any!, V : Any!> unmodifiableMap(m: MutableMap<out K, out V>): MutableMap<K, V>

Returns an unmodifiable view of the specified map. Query operations on the returned map "read through" to the specified map, and attempts to modify the returned map, whether direct or via its collection views, result in an UnsupportedOperationException.

The returned map will be serializable if the specified map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	MutableMap<out K, out V>: the map for which an unmodifiable view is to be returned.

Return
MutableMap<K, V>	an unmodifiable view of the specified map.

unmodifiableNavigableMap

Added in API level 26

open static fun <K : Any!, V : Any!> unmodifiableNavigableMap(m: NavigableMap<K, out V>): NavigableMap<K, V>

Returns an unmodifiable view of the specified navigable map. Query operations on the returned navigable map "read through" to the specified navigable map. Attempts to modify the returned navigable map, whether direct, via its collection views, or via its subMap, headMap, or tailMap views, result in an UnsupportedOperationException.

The returned navigable map will be serializable if the specified navigable map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	NavigableMap<K, out V>: the navigable map for which an unmodifiable view is to be returned

Return
NavigableMap<K, V>	an unmodifiable view of the specified navigable map

unmodifiableNavigableSet

Added in API level 26

open static fun <T : Any!> unmodifiableNavigableSet(s: NavigableSet<T>): NavigableSet<T>

Returns an unmodifiable view of the specified navigable set. Query operations on the returned navigable set "read through" to the specified navigable set. Attempts to modify the returned navigable set, whether direct, via its iterator, or via its subSet, headSet, or tailSet views, result in an UnsupportedOperationException.

The returned navigable set will be serializable if the specified navigable set is serializable.

Parameters
<T>	the class of the objects in the set
s	NavigableSet<T>: the navigable set for which an unmodifiable view is to be returned

Return
NavigableSet<T>	an unmodifiable view of the specified navigable set

unmodifiableSequencedCollection

Added in API level 35

open static fun <T : Any!> unmodifiableSequencedCollection(c: SequencedCollection<out T>): SequencedCollection<T>

Returns an unmodifiable view of the specified SequencedCollection. Query operations on the returned collection "read through" to the specified collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.

The returned collection will be serializable if the specified collection is serializable.

Parameters
<T>	the class of the objects in the collection
c	SequencedCollection<out T>: the collection for which an unmodifiable view is to be returned.

Return
SequencedCollection<T>	an unmodifiable view of the specified collection.

unmodifiableSequencedMap

Added in API level 35

open static fun <K : Any!, V : Any!> unmodifiableSequencedMap(m: SequencedMap<out K, out V>): SequencedMap<K, V>

Returns an unmodifiable view of the specified SequencedMap. Query operations on the returned map "read through" to the specified map, and attempts to modify the returned map, whether direct or via its collection views, result in an UnsupportedOperationException.

The returned map will be serializable if the specified map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	SequencedMap<out K, out V>: the map for which an unmodifiable view is to be returned.

Return
SequencedMap<K, V>	an unmodifiable view of the specified map.

unmodifiableSequencedSet

Added in API level 35

open static fun <T : Any!> unmodifiableSequencedSet(s: SequencedSet<out T>): SequencedSet<T>

Returns an unmodifiable view of the specified SequencedSet. Query operations on the returned set "read through" to the specified set, and attempts to modify the returned set, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned set will be serializable if the specified set is serializable.

Parameters
<T>	the class of the objects in the set
s	SequencedSet<out T>: the set for which an unmodifiable view is to be returned.

Return
SequencedSet<T>	an unmodifiable view of the specified sequenced set.

unmodifiableSet

Added in API level 1

open static fun <T : Any!> unmodifiableSet(s: MutableSet<out T>): MutableSet<T>

Returns an unmodifiable view of the specified set. Query operations on the returned set "read through" to the specified set, and attempts to modify the returned set, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned set will be serializable if the specified set is serializable.

Parameters
<T>	the class of the objects in the set
s	MutableSet<out T>: the set for which an unmodifiable view is to be returned.

Return
MutableSet<T>	an unmodifiable view of the specified set.

unmodifiableSortedMap

Added in API level 1

open static fun <K : Any!, V : Any!> unmodifiableSortedMap(m: SortedMap<K, out V>): SortedMap<K, V>

Returns an unmodifiable view of the specified sorted map. Query operations on the returned sorted map "read through" to the specified sorted map. Attempts to modify the returned sorted map, whether direct, via its collection views, or via its subMap, headMap, or tailMap views, result in an UnsupportedOperationException.

The returned sorted map will be serializable if the specified sorted map is serializable.

Parameters
<K>	the class of the map keys
<V>	the class of the map values
m	SortedMap<K, out V>: the sorted map for which an unmodifiable view is to be returned.

Return
SortedMap<K, V>	an unmodifiable view of the specified sorted map.

unmodifiableSortedSet

Added in API level 1

open static fun <T : Any!> unmodifiableSortedSet(s: SortedSet<T>): SortedSet<T>

Returns an unmodifiable view of the specified sorted set. Query operations on the returned sorted set "read through" to the specified sorted set. Attempts to modify the returned sorted set, whether direct, via its iterator, or via its subSet, headSet, or tailSet views, result in an UnsupportedOperationException.

The returned sorted set will be serializable if the specified sorted set is serializable.

Parameters
<T>	the class of the objects in the set
s	SortedSet<T>: the sorted set for which an unmodifiable view is to be returned.

Return
SortedSet<T>	an unmodifiable view of the specified sorted set.

Properties

EMPTY_LIST

Added in API level 1

static val EMPTY_LIST: MutableList<Any?>

The empty list (immutable). This list is serializable.

See Also

• #emptyList()

EMPTY_MAP

Added in API level 1

static val EMPTY_MAP: MutableMap<Any?, Any?>

The empty map (immutable). This map is serializable.

See Also

• #emptyMap()

EMPTY_SET

Added in API level 1

static val EMPTY_SET: MutableSet<Any?>

The empty set (immutable). This set is serializable.

See Also

• #emptySet()