LinkedList | API reference | Android Developers (original) (raw)
open class LinkedList<E : Any!> : AbstractSequentialList, Cloneable, Deque, Serializable, MutableList
| kotlin.Any | |||
|---|---|---|---|
| ↳ | java.util.AbstractCollection | ||
| ↳ | java.util.AbstractList | ||
| ↳ | java.util.AbstractSequentialList | ||
| ↳ |
Doubly-linked list implementation of the List and Deque interfaces. Implements all optional list operations, and permits all elements (including null).
All of the operations perform as could be expected for a doubly-linked list. Operations that index into the list will traverse the list from the beginning or the end, whichever is closer to the specified index.
Note that this implementation is not synchronized. If multiple threads access a linked list concurrently, and at least one of the threads modifies the list structurally, it must be synchronized externally. (A structural modification is any operation that adds or deletes one or more elements; merely setting the value of an element is not a structural modification.) This is typically accomplished by synchronizing on some object that naturally encapsulates the list. If no such object exists, the list should be "wrapped" using the [Collections.synchronizedList](/reference/kotlin/java/util/Collections#synchronizedList%28kotlin.collections.MutableList%29) method. This is best done at creation time, to prevent accidental unsynchronized access to the list:
List list = Collections.synchronizedList(new LinkedList(...));
The iterators returned by this class's iterator and listIterator methods are fail-fast: if the list is structurally modified at any time after the iterator is created, in any way except through the Iterator's own remove or add methods, the iterator will throw a [ConcurrentModificationException](/reference/kotlin/java/util/ConcurrentModificationException). Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.
Note that the fail-fast behavior of an iterator cannot be guaranteed as it is, generally speaking, impossible to make any hard guarantees in the presence of unsynchronized concurrent modification. Fail-fast iterators throw ConcurrentModificationException on a best-effort basis. Therefore, it would be wrong to write a program that depended on this exception for its correctness: the fail-fast behavior of iterators should be used only to detect bugs.
This class is a member of the Java Collections Framework.
Summary
| Public constructors |
|---|
| LinkedList() Constructs an empty list. |
| LinkedList(c: MutableCollection<out E>) Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. |
| Public methods | |
|---|---|
| open Boolean | add(element: E) Appends the specified element to the end of this list. |
| open Unit | add(index: Int, element: E) Inserts the specified element at the specified position in this list. |
| open Boolean | addAll(index: Int, elements: Collection<E>) Inserts all of the elements in the specified collection into this list, starting at the specified position. |
| open Boolean | addAll(elements: Collection<E>) 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. |
| open Unit | addFirst(e: E) Inserts the specified element at the beginning of this list. |
| open Unit | addLast(e: E) Appends the specified element to the end of this list. |
| open Unit | clear() Removes all of the elements from this list. |
| open Any | clone() Returns a shallow copy of this LinkedList. |
| open Boolean | contains(element: E) Returns true if this list contains the specified element. |
| open Boolean | contains(element: E) Returns true if this list contains the specified element. |
| open MutableIterator<E> | descendingIterator() |
| open E | element() Retrieves, but does not remove, the head (first element) of this list. |
| open E | get(index: Int) Returns the element at the specified position in this list. |
| open E | getFirst() Returns the first element in this list. |
| open E | getLast() Returns the last element in this list. |
| open Int | indexOf(element: E) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. |
| open Int | indexOf(element: E) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. |
| open Int | lastIndexOf(element: E) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. |
| open Int | lastIndexOf(element: E) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. |
| open MutableListIterator<E> | listIterator(index: Int) Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list. |
| open Boolean | offer(e: E) Adds the specified element as the tail (last element) of this list. |
| open Boolean | offerFirst(e: E) Inserts the specified element at the front of this list. |
| open Boolean | offerLast(e: E) Inserts the specified element at the end of this list. |
| open E? | peek() Retrieves, but does not remove, the head (first element) of this list. |
| open E? | peekFirst() Retrieves, but does not remove, the first element of this list, or returns null if this list is empty. |
| open E? | peekLast() Retrieves, but does not remove, the last element of this list, or returns null if this list is empty. |
| open E? | poll() Retrieves and removes the head (first element) of this list. |
| open E? | pollFirst() Retrieves and removes the first element of this list, or returns null if this list is empty. |
| open E? | pollLast() Retrieves and removes the last element of this list, or returns null if this list is empty. |
| open E | pop() Pops an element from the stack represented by this list. |
| open Unit | push(e: E) Pushes an element onto the stack represented by this list. |
| open E | remove() Retrieves and removes the head (first element) of this list. |
| open Boolean | remove(element: E) Removes the first occurrence of the specified element from this list, if it is present. |
| open Boolean | remove(element: E) Removes the first occurrence of the specified element from this list, if it is present. |
| open E | removeAt(index: Int) Removes the element at the specified position in this list. |
| open E | removeFirst() Removes and returns the first element from this list. |
| open Boolean | removeFirstOccurrence(o: Any?) Removes the first occurrence of the specified element in this list (when traversing the list from head to tail). |
| open E | removeLast() Removes and returns the last element from this list. |
| open Boolean | removeLastOccurrence(o: Any?) Removes the last occurrence of the specified element in this list (when traversing the list from head to tail). |
| open LinkedList<E> | reversed() Returns a reverse-ordered view of this collection. |
| open E | set(index: Int, element: E) Replaces the element at the specified position in this list with the specified element. |
| open Spliterator<E> | spliterator() Creates a late-binding and fail-fast Spliterator over the elements in this list. |
| open Array<Any!> | toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element). |
| open Array<T> | toArray(a: 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. |
| Inherited functions |
|---|
From class AbstractList Boolean add(element: E) Appends the specified element to the end of this list (optional operation). Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added. Unit clear() Removes all of the elements from this list (optional operation). The list will be empty after this call returns. Boolean equals(other: Any?) Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. Int hashCode() Returns the hash code value for this list. Int indexOf(element: E?) 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. Int lastIndexOf(element: E?) 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. MutableListIterator<E> listIterator() Returns a list iterator over the elements in this list (in proper sequence). Unit removeRange(fromIndex: Int, toIndex: Int) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.) This method is called by the clear operation on this list and its subLists. Overriding this method to take advantage of the internals of the list implementation can substantially improve the performance of the clear operation on this list and its subLists. MutableList<E> subList(fromIndex: Int, toIndex: Int) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndextoIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list. This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list: list.subList(from, to).clear(); structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.) |
| From class AbstractCollection Boolean addAll(elements: Collectionencounter order, processing of its elements generally occurs in that order. Boolean contains(element: E?) Returns true if this collection contains the specified element. More formally, returns true if and only if this collection contains at least one element e such that Objects.equals(o, e). Boolean containsAll(elements: CollectionBoolean isEmpty() Returns true if this collection contains no elements. Boolean remove(element: E?) Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that Objects.equals(o, e), if this collection contains one or more such elements. Returns true if this collection contained the specified element (or equivalently, if this collection changed as a result of the call). Boolean removeAll(elements: CollectionBoolean retainAll(elements: CollectionArray<Any!> toArray() Returns an array containing all of the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is Object. The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array. ArraytoArray(a: Arrayonly if the caller knows that this collection does not contain any null elements.) If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. String toString() Returns a string representation of this collection. The string representation consists of a list of the collection'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). |
| From class AbstractSequentialList MutableIteratoriterator() Returns an iterator over the elements in this list (in proper sequence). This implementation merely returns a list iterator over the list. |
| Properties | |
|---|---|
| open Int | size Returns the number of elements in this list. |
| Inherited properties |
|---|
| From class AbstractList Int modCount The number of times this list has been structurally modified. Structural modifications are those that change the size of the list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results. This field is used by the iterator and list iterator implementation returned by the iterator and listIterator methods. If the value of this field changes unexpectedly, the iterator (or list iterator) will throw a ConcurrentModificationException in response to the next, remove, previous, set or add operations. This provides fail-fast behavior, rather than non-deterministic behavior in the face of concurrent modification during iteration. Use of this field by subclasses is optional. If a subclass wishes to provide fail-fast iterators (and list iterators), then it merely has to increment this field in its add(int, E) and remove(int) methods (and any other methods that it overrides that result in structural modifications to the list). A single call to add(int, E) or remove(int) must add no more than one to this field, or the iterators (and list iterators) will throw bogus ConcurrentModificationExceptions. If an implementation does not wish to provide fail-fast iterators, this field may be ignored. |
| From class AbstractCollection Int size |
Public constructors
LinkedList
LinkedList()
Constructs an empty list.
LinkedList
LinkedList(c: MutableCollection)
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
| Parameters | |
|---|---|
| c | MutableCollection |
| Exceptions | |
|---|---|
| java.lang.NullPointerException | if the specified collection is null |
Public methods
add
open fun add(element: E): Boolean
Appends the specified element to the end of this list.
This method is equivalent to #addLast.
| Parameters | |
|---|---|
| e | element to be appended to this list |
| Return | |
|---|---|
| Boolean | true (as specified by Collection.add) |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the add operation is not supported by this list |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this list |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements |
| java.lang.IllegalArgumentException | if some property of this element prevents it from being added to this list |
| java.lang.IllegalStateException | if the element cannot be added at this time due to capacity restrictions |
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).
| Parameters | |
|---|---|
| index | Int: index at which the specified element is to be inserted |
| element | E: element to be inserted |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the add operation is not supported by this list |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this list |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this list |
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
addAll
open fun addAll(
index: Int,
elements: Collection
): 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 the list in the order that they are returned by the specified collection's iterator.
| Parameters | |
|---|---|
| index | Int: index at which to insert the first element from the specified collection |
| c | collection containing elements to be added to this list |
| Return | |
|---|---|
| Boolean | true if this list changed as a result of the call |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the addAll operation is not supported by this list |
| java.lang.ClassCastException | if the class of an element of the specified collection prevents it from being added to this list |
| java.lang.NullPointerException | if the specified collection is null |
| java.lang.IllegalArgumentException | if some property of an element of the specified collection prevents it from being added to this list |
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
addAll
open fun addAll(elements: Collection): 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. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)
| Parameters | |
|---|---|
| c | collection containing elements to be added to this list |
| Return | |
|---|---|
| Boolean | true if this list changed as a result of the call |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the addAll operation is not supported by this list |
| java.lang.ClassCastException | if the class of an element of the specified collection prevents it from being added to this deque |
| java.lang.NullPointerException | if the specified collection is null |
| java.lang.IllegalArgumentException | if some property of an element of the specified collection prevents it from being added to this deque |
| java.lang.IllegalStateException | if not all the elements can be added at this time due to insertion restrictions |
addFirst
open fun addFirst(e: E): Unit
Inserts the specified element at the beginning of this list.
| Parameters | |
|---|---|
| e | E: the element to add |
| Exceptions | |
|---|---|
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.UnsupportedOperationException | if this collection implementation does not support this operation |
| java.lang.IllegalStateException | if the element cannot be added at this time due to capacity restrictions |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
addLast
open fun addLast(e: E): Unit
Appends the specified element to the end of this list.
This method is equivalent to #add.
| Parameters | |
|---|---|
| e | E: the element to add |
| Exceptions | |
|---|---|
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.UnsupportedOperationException | if this collection implementation does not support this operation |
| java.lang.IllegalStateException | if the element cannot be added at this time due to capacity restrictions |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
clear
open fun clear(): Unit
Removes all of the elements from this list. The list will be empty after this call returns.
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the clear operation is not supported by this list |
clone
open fun clone(): Any
Returns a shallow copy of this LinkedList. (The elements themselves are not cloned.)
| Return | |
|---|---|
| Any | a shallow copy of this LinkedList instance |
| Exceptions | |
|---|---|
| java.lang.CloneNotSupportedException | if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned. |
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).
| Parameters | |
|---|---|
| o | element whose presence in this list is to be tested |
| Return | |
|---|---|
| Boolean | true if this list contains the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
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).
| Parameters | |
|---|---|
| o | element whose presence in this list is to be tested |
| Return | |
|---|---|
| Boolean | true if this list contains the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
descendingIterator
open fun descendingIterator(): MutableIterator
| Return | |
|---|---|
| MutableIterator | an iterator over the elements in this deque in reverse sequence |
element
open fun element(): E
Retrieves, but does not remove, the head (first element) of this list.
| Return | |
|---|---|
| E | the head of this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
get
open fun get(index: Int): E
Returns the element at the specified position in this list.
| Parameters | |
|---|---|
| index | Int: index of the element to return |
| Return | |
|---|---|
| E | the element at the specified position in this list |
| Exceptions | |
|---|---|
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
getFirst
open fun getFirst(): E
Returns the first element in this list.
| Return | |
|---|---|
| E | the first element in this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
getLast
open fun getLast(): E
Returns the last element in this list.
| Return | |
|---|---|
| E | the last element in this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
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.
| Parameters | |
|---|---|
| o | element to search for |
| Return | |
|---|---|
| Int | the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the type of the specified element is incompatible with this list (optional) |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements (optional) |
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.
| Parameters | |
|---|---|
| o | element to search for |
| Return | |
|---|---|
| Int | the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the type of the specified element is incompatible with this list (optional) |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements (optional) |
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.
| Parameters | |
|---|---|
| o | element to search for |
| Return | |
|---|---|
| Int | the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the type of the specified element is incompatible with this list (optional) |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements (optional) |
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.
| Parameters | |
|---|---|
| o | element to search for |
| Return | |
|---|---|
| Int | the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the type of the specified element is incompatible with this list (optional) |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements (optional) |
listIterator
open fun listIterator(index: Int): MutableListIterator
Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list. Obeys the general contract of List.listIterator(int).
The list-iterator is fail-fast: if the list is structurally modified at any time after the Iterator is created, in any way except through the list-iterator's own remove or add methods, the list-iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.
| Parameters | |
|---|---|
| index | Int: index of the first element to be returned from the list-iterator (by a call to next) |
| Return | |
|---|---|
| MutableListIterator | a ListIterator of the elements in this list (in proper sequence), starting at the specified position in the list |
| Exceptions | |
|---|---|
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
offer
open fun offer(e: E): Boolean
Adds the specified element as the tail (last element) of this list.
| Parameters | |
|---|---|
| e | E: the element to add |
| Return | |
|---|---|
| Boolean | true (as specified by Queue.offer) |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
offerFirst
open fun offerFirst(e: E): Boolean
Inserts the specified element at the front of this list.
| Parameters | |
|---|---|
| e | E: the element to insert |
| Return | |
|---|---|
| Boolean | true (as specified by Deque.offerFirst) |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
offerLast
open fun offerLast(e: E): Boolean
Inserts the specified element at the end of this list.
| Parameters | |
|---|---|
| e | E: the element to insert |
| Return | |
|---|---|
| Boolean | true (as specified by Deque.offerLast) |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
peek
open fun peek(): E?
Retrieves, but does not remove, the head (first element) of this list.
| Return | |
|---|---|
| E? | the head of this list, or null if this list is empty |
peekFirst
open fun peekFirst(): E?
Retrieves, but does not remove, the first element of this list, or returns null if this list is empty.
| Return | |
|---|---|
| E? | the first element of this list, or null if this list is empty |
peekLast
open fun peekLast(): E?
Retrieves, but does not remove, the last element of this list, or returns null if this list is empty.
| Return | |
|---|---|
| E? | the last element of this list, or null if this list is empty |
poll
open fun poll(): E?
Retrieves and removes the head (first element) of this list.
| Return | |
|---|---|
| E? | the head of this list, or null if this list is empty |
pollFirst
open fun pollFirst(): E?
Retrieves and removes the first element of this list, or returns null if this list is empty.
| Return | |
|---|---|
| E? | the first element of this list, or null if this list is empty |
pollLast
open fun pollLast(): E?
Retrieves and removes the last element of this list, or returns null if this list is empty.
| Return | |
|---|---|
| E? | the last element of this list, or null if this list is empty |
pop
open fun pop(): E
Pops an element from the stack represented by this list. In other words, removes and returns the first element of this list.
This method is equivalent to #removeFirst().
| Return | |
|---|---|
| E | the element at the front of this list (which is the top of the stack represented by this list) |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
push
open fun push(e: E): Unit
Pushes an element onto the stack represented by this list. In other words, inserts the element at the front of this list.
This method is equivalent to #addFirst.
| Parameters | |
|---|---|
| e | E: the element to push |
| Exceptions | |
|---|---|
| java.lang.IllegalStateException | if the element cannot be added at this time due to capacity restrictions |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this deque |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this deque |
remove
open fun remove(): E
Retrieves and removes the head (first element) of this list.
| Return | |
|---|---|
| E | the head of this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
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).
| Parameters | |
|---|---|
| o | element to be removed from this list, if present |
| Return | |
|---|---|
| Boolean | true if this list contained the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
| java.lang.UnsupportedOperationException | if the remove operation is not supported by this list |
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).
| Parameters | |
|---|---|
| o | element to be removed from this list, if present |
| Return | |
|---|---|
| Boolean | true if this list contained the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
| java.lang.UnsupportedOperationException | if the remove operation is not supported by this list |
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.
| Parameters | |
|---|---|
| index | Int: the index of the element to be removed |
| Return | |
|---|---|
| E | the element previously at the specified position |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the remove operation is not supported by this list |
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
removeFirst
open fun removeFirst(): E
Removes and returns the first element from this list.
| Return | |
|---|---|
| E | the first element from this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
| java.lang.UnsupportedOperationException | if this collection implementation does not support this operation |
removeFirstOccurrence
open fun removeFirstOccurrence(o: Any?): Boolean
Removes the first occurrence of the specified element in this list (when traversing the list from head to tail). If the list does not contain the element, it is unchanged.
| Parameters | |
|---|---|
| o | Any?: element to be removed from this list, if present |
| Return | |
|---|---|
| Boolean | true if the list contained the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
removeLast
open fun removeLast(): E
Removes and returns the last element from this list.
| Return | |
|---|---|
| E | the last element from this list |
| Exceptions | |
|---|---|
| java.util.NoSuchElementException | if this list is empty |
| java.lang.UnsupportedOperationException | if this collection implementation does not support this operation |
removeLastOccurrence
open fun removeLastOccurrence(o: Any?): Boolean
Removes the last occurrence of the specified element in this list (when traversing the list from head to tail). If the list does not contain the element, it is unchanged.
| Parameters | |
|---|---|
| o | Any?: element to be removed from this list, if present |
| Return | |
|---|---|
| Boolean | true if the list contained the specified element |
| Exceptions | |
|---|---|
| java.lang.ClassCastException | if the class of the specified element is incompatible with this deque (java.util.Collection#) |
| java.lang.NullPointerException | if the specified element is null and this deque does not permit null elements (java.util.Collection#) |
reversed
open fun reversed(): LinkedList
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.
| Return | |
|---|---|
| LinkedList | a reverse-ordered view of this collection, as a List |
set
open fun set(
index: Int,
element: E
): E
Replaces the element at the specified position in this list with the specified element.
| Parameters | |
|---|---|
| index | Int: index of the element to replace |
| element | E: element to be stored at the specified position |
| Return | |
|---|---|
| E | the element previously at the specified position |
| Exceptions | |
|---|---|
| java.lang.UnsupportedOperationException | if the set operation is not supported by this list |
| java.lang.ClassCastException | if the class of the specified element prevents it from being added to this list |
| java.lang.NullPointerException | if the specified element is null and this list does not permit null elements |
| java.lang.IllegalArgumentException | if some property of the specified element prevents it from being added to this list |
| java.lang.IndexOutOfBoundsException | if the index is out of range (index < 0 | |
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.
| Return | |
|---|---|
| Array<Any!> | an array containing all of the elements in this list in proper sequence |
toArray
open fun Any!> toArray(a: Array): Array
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 the list fits in the specified array with room to spare (i.e., the array has more elements than the 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 the list only if the caller knows that the list does not contain any null elements.)
Like the [toArray()](#toArray%28%29) 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:
String[] y = x.toArray(new String[0]);
Note that toArray(new Object[0]) is identical in function to toArray().
| Parameters | |
|---|---|
| the component type of the array to contain the collection | |
| a | Array |
| Return | |
|---|---|
| Array | an array containing the elements of the list |
| Exceptions | |
|---|---|
| java.lang.ArrayStoreException | if the runtime type of the specified array is not a supertype of the runtime type of every element in this list |
| java.lang.NullPointerException | if the specified array is null |
Properties
size
open val size: Int
Returns the number of elements in this list.
| Return | |
|---|---|
| Int | the number of elements in this list |