CopyOnWriteArrayList

CopyOnWriteArrayList

CopyOnWriteArrayList()

Creates an empty list.

CopyOnWriteArrayList

CopyOnWriteArrayList(c: MutableCollection<out E>)

Creates a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

CopyOnWriteArrayList

CopyOnWriteArrayList(toCopyIn: Array<E>)

Creates a list holding a copy of the given array.

add

open fun add(element: E): Boolean

Appends the specified element to the end of this list.

add

open fun add(
    index: Int, 
    element: E
): Unit

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

addAll

open fun addAll(elements: Collection<E>): Boolean

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator.

addAll

open fun addAll(
    index: Int, 
    elements: Collection<E>
): Boolean

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator.

addAllAbsent

open fun addAllAbsent(c: MutableCollection<out E>): Int

Appends all of the elements in the specified collection that are not already contained in this list, to the end of this list, in the order that they are returned by the specified collection's iterator.

addFirst

open fun addFirst(e: E): Unit

Adds an element as the first element of this collection (optional operation). After this operation completes normally, the given element will be a member of this collection, and it will be the first element in encounter order.

addIfAbsent

open fun addIfAbsent(e: E): Boolean

Appends the element, if not present.

addLast

open fun addLast(e: E): Unit

Adds an element as the last element of this collection (optional operation). After this operation completes normally, the given element will be a member of this collection, and it will be the last element in encounter order.

clear

open fun clear(): Unit

Removes all of the elements from this list. The list will be empty after this call returns.

clone

open fun clone(): Any

Returns a shallow copy of this list. (The elements themselves are not copied.)

contains

open fun contains(element: E?): Boolean

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that Objects.equals(o, e).

containsAll

open fun containsAll(elements: Collection<E>): Boolean

Returns true if this list contains all of the elements of the specified collection.

equals

open fun equals(other: Any?): Boolean

Compares the specified object with this list for equality. Returns true if the specified object is the same object as this object, or if it is also a List and the sequence of elements returned by an java.util.List#iterator() over the specified list is the same as the sequence returned by an iterator over this list. The two sequences are considered to be the same if they have the same length and corresponding elements at the same position in the sequence are equal. Two elements e1 and e2 are considered equal if Objects.equals(e1, e2).

forEach

open fun forEach(action: Consumer<in E>): Unit

get

open fun get(index: Int): E

Returns the element at the specified position in this list.

getFirst

open fun getFirst(): E

Gets the first element of this collection.

getLast

open fun getLast(): E

Gets the last element of this collection.

hashCode

open fun hashCode(): Int

Returns the hash code value for this list.

This implementation uses the definition in java.util.List#hashCode.

indexOf

open fun indexOf(
    e: E?, 
    index: Int
): Int

Returns the index of the first occurrence of the specified element in this list, searching forwards from index, or returns -1 if the element is not found. More formally, returns the lowest index i such that i >= index && Objects.equals(get(i), e), or -1 if there is no such index.

indexOf

open fun indexOf(element: E?): Int

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

isEmpty

open fun isEmpty(): Boolean

Returns true if this list contains no elements.

iterator

open fun iterator(): MutableIterator<E>

Returns an iterator over the elements in this list in proper sequence.

The returned iterator provides a snapshot of the state of the list when the iterator was constructed. No synchronization is needed while traversing the iterator. The iterator does NOT support the remove method.

lastIndexOf

open fun lastIndexOf(
    e: E?, 
    index: Int
): Int

Returns the index of the last occurrence of the specified element in this list, searching backwards from index, or returns -1 if the element is not found. More formally, returns the highest index i such that i <= index && Objects.equals(get(i), e), or -1 if there is no such index.

lastIndexOf

open fun lastIndexOf(element: E?): Int

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that Objects.equals(o, get(i)), or -1 if there is no such index.

listIterator

open fun listIterator(): MutableListIterator<E>

Returns a list iterator over the elements in this list (in proper sequence).

The returned iterator provides a snapshot of the state of the list when the iterator was constructed. No synchronization is needed while traversing the iterator. The iterator does NOT support the remove, set or add methods.

listIterator

open fun listIterator(index: Int): MutableListIterator<E>

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

The returned iterator provides a snapshot of the state of the list when the iterator was constructed. No synchronization is needed while traversing the iterator. The iterator does NOT support the remove, set or add methods.

remove

open fun remove(element: E?): Boolean

Removes the first occurrence of the specified element from this list, if it is present. If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that Objects.equals(o, get(i)) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

removeAll

open fun removeAll(elements: Collection<E>): Boolean

Removes from this list all of its elements that are contained in the specified collection. This is a particularly expensive operation in this class because of the need for an internal temporary array.

removeAt

open fun removeAt(index: Int): E

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

removeFirst

open fun removeFirst(): E

Removes and returns the first element of this collection (optional operation).

removeIf

open fun removeIf(filter: Predicate<in E>): Boolean

removeLast

open fun removeLast(): E

Removes and returns the last element of this collection (optional operation).

replaceAll

open fun replaceAll(operator: UnaryOperator<E>): Unit

retainAll

open fun retainAll(elements: Collection<E>): Boolean

Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all of its elements that are not contained in the specified collection.

reversed

open fun reversed(): MutableList<E>

Returns a reverse-ordered view of this collection. The encounter order of elements in the returned view is the inverse of the encounter order of elements in this collection. The reverse ordering affects all order-sensitive operations, including those on the view collections of the returned view. If the collection implementation permits modifications to this view, the modifications "write through" to the underlying collection. Changes to the underlying collection might or might not be visible in this reversed view, depending upon the implementation.

Modifications to the reversed view are permitted and will be propagated to this list. In addition, modifications to this list will be visible in the reversed view. Sublists and iterators of the reversed view have the same restrictions as those of this list.

set

open fun set(
    index: Int, 
    element: E
): E

Replaces the element at the specified position in this list with the specified element.

sort

open fun sort(c: Comparator<in E>?): Unit

spliterator

open fun spliterator(): Spliterator<E>

Returns a Spliterator over the elements in this list.

The Spliterator reports Spliterator#IMMUTABLE, Spliterator#ORDERED, Spliterator#SIZED, and Spliterator#SUBSIZED.

The spliterator provides a snapshot of the state of the list when the spliterator was constructed. No synchronization is needed while operating on the spliterator.

subList

open fun subList(
    fromIndex: Int, 
    toIndex: Int
): MutableList<E>

Returns a view of the portion of this list between fromIndex, inclusive, and toIndex, exclusive. The returned list is backed by this list, so changes in the returned list are reflected in this list.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is modified in any way other than via the returned list.

toArray

open fun toArray(): Array<Any!>

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

toArray

open fun <T : Any!> toArray(a: Array<T>): Array<T>

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If this list fits in the specified array with room to spare (i.e., the array has more elements than this list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of this list only if the caller knows that this list does not contain any null elements.)

Like the #toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

<code>String[] y = x.toArray(new String[0]);</code>

toString

open fun toString(): String

Returns a string representation of this list. The string representation consists of the string representations of the list's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf(Object).

size

open val size: Int

Returns the number of elements in this list.