Method from java.util.LinkedList Detail: |
public boolean add(E e) {
linkLast(e);
return true;
}
|
public void add(int index,
E element) {
checkPositionIndex(index);
if (index == size)
linkLast(element);
else
linkBefore(element, node(index));
}
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). |
public boolean addAll(Collection<? extends E> c) {
return addAll(size, c);
}
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.) |
public boolean addAll(int index,
Collection<? extends E> c) {
checkPositionIndex(index);
Object[] a = c.toArray();
int numNew = a.length;
if (numNew == 0)
return false;
Node< E > pred, succ;
if (index == size) {
succ = null;
pred = last;
} else {
succ = node(index);
pred = succ.prev;
}
for (Object o : a) {
@SuppressWarnings("unchecked") E e = (E) o;
Node< E > newNode = new Node< >(pred, e, null);
if (pred == null)
first = newNode;
else
pred.next = newNode;
pred = newNode;
}
if (succ == null) {
last = pred;
} else {
pred.next = succ;
succ.prev = pred;
}
size += numNew;
modCount++;
return true;
}
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. |
public void addFirst(E e) {
linkFirst(e);
}
Inserts the specified element at the beginning of this list. |
public void addLast(E e) {
linkLast(e);
}
|
public void clear() {
// Clearing all of the links between nodes is "unnecessary", but:
// - helps a generational GC if the discarded nodes inhabit
// more than one generation
// - is sure to free memory even if there is a reachable Iterator
for (Node< E > x = first; x != null; ) {
Node< E > next = x.next;
x.item = null;
x.next = null;
x.prev = null;
x = next;
}
first = last = null;
size = 0;
modCount++;
}
Removes all of the elements from this list.
The list will be empty after this call returns. |
public Object clone() {
LinkedList< E > clone = superClone();
// Put clone into "virgin" state
clone.first = clone.last = null;
clone.size = 0;
clone.modCount = 0;
// Initialize clone with our elements
for (Node< E > x = first; x != null; x = x.next)
clone.add(x.item);
return clone;
}
Returns a shallow copy of this {@code LinkedList}. (The elements
themselves are not cloned.) |
public boolean contains(Object o) {
return indexOf(o) != -1;
}
Returns {@code true} if this list contains the specified element.
More formally, returns {@code true} if and only if this list contains
at least one element {@code e} such that
(o==null ? e==null : o.equals(e)). |
public Iterator<E> descendingIterator() {
return new DescendingIterator();
}
|
public E element() {
return getFirst();
}
Retrieves, but does not remove, the head (first element) of this list. |
public E get(int index) {
checkElementIndex(index);
return node(index).item;
}
Returns the element at the specified position in this list. |
public E getFirst() {
final Node< E > f = first;
if (f == null)
throw new NoSuchElementException();
return f.item;
}
Returns the first element in this list. |
public E getLast() {
final Node< E > l = last;
if (l == null)
throw new NoSuchElementException();
return l.item;
}
Returns the last element in this list. |
public int indexOf(Object o) {
int index = 0;
if (o == null) {
for (Node< E > x = first; x != null; x = x.next) {
if (x.item == null)
return index;
index++;
}
} else {
for (Node< E > x = first; x != null; x = x.next) {
if (o.equals(x.item))
return index;
index++;
}
}
return -1;
}
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 {@code i} such that
(o==null ? get(i)==null : o.equals(get(i))),
or -1 if there is no such index. |
public int lastIndexOf(Object o) {
int index = size;
if (o == null) {
for (Node< E > x = last; x != null; x = x.prev) {
index--;
if (x.item == null)
return index;
}
} else {
for (Node< E > x = last; x != null; x = x.prev) {
index--;
if (o.equals(x.item))
return index;
}
}
return -1;
}
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 {@code i} such that
(o==null ? get(i)==null : o.equals(get(i))),
or -1 if there is no such index. |
void linkBefore(E e,
Node<E> succ) {
// assert succ != null;
final Node< E > pred = succ.prev;
final Node< E > newNode = new Node< >(pred, e, succ);
succ.prev = newNode;
if (pred == null)
first = newNode;
else
pred.next = newNode;
size++;
modCount++;
}
Inserts element e before non-null Node succ. |
void linkLast(E e) {
final Node< E > l = last;
final Node< E > newNode = new Node< >(l, e, null);
last = newNode;
if (l == null)
first = newNode;
else
l.next = newNode;
size++;
modCount++;
}
|
public ListIterator<E> listIterator(int index) {
checkPositionIndex(index);
return new ListItr(index);
}
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 {@code 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 {@code remove} or {@code add}
methods, the list-iterator will throw a
{@code 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. |
Node<E> node(int index) {
// assert isElementIndex(index);
if (index < (size > > 1)) {
Node< E > x = first;
for (int i = 0; i < index; i++)
x = x.next;
return x;
} else {
Node< E > x = last;
for (int i = size - 1; i > index; i--)
x = x.prev;
return x;
}
}
Returns the (non-null) Node at the specified element index. |
public boolean offer(E e) {
return add(e);
}
Adds the specified element as the tail (last element) of this list. |
public boolean offerFirst(E e) {
addFirst(e);
return true;
}
Inserts the specified element at the front of this list. |
public boolean offerLast(E e) {
addLast(e);
return true;
}
Inserts the specified element at the end of this list. |
public E peek() {
final Node< E > f = first;
return (f == null) ? null : f.item;
}
Retrieves, but does not remove, the head (first element) of this list. |
public E peekFirst() {
final Node< E > f = first;
return (f == null) ? null : f.item;
}
Retrieves, but does not remove, the first element of this list,
or returns {@code null} if this list is empty. |
public E peekLast() {
final Node< E > l = last;
return (l == null) ? null : l.item;
}
Retrieves, but does not remove, the last element of this list,
or returns {@code null} if this list is empty. |
public E poll() {
final Node< E > f = first;
return (f == null) ? null : unlinkFirst(f);
}
Retrieves and removes the head (first element) of this list. |
public E pollFirst() {
final Node< E > f = first;
return (f == null) ? null : unlinkFirst(f);
}
Retrieves and removes the first element of this list,
or returns {@code null} if this list is empty. |
public E pollLast() {
final Node< E > l = last;
return (l == null) ? null : unlinkLast(l);
}
Retrieves and removes the last element of this list,
or returns {@code null} if this list is empty. |
public E pop() {
return removeFirst();
}
|
public void push(E e) {
addFirst(e);
}
|
public E remove() {
return removeFirst();
}
Retrieves and removes the head (first element) of this list. |
public boolean remove(Object o) {
if (o == null) {
for (Node< E > x = first; x != null; x = x.next) {
if (x.item == null) {
unlink(x);
return true;
}
}
} else {
for (Node< E > x = first; x != null; x = x.next) {
if (o.equals(x.item)) {
unlink(x);
return true;
}
}
}
return false;
}
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
{@code i} such that
(o==null ? get(i)==null : o.equals(get(i)))
(if such an element exists). Returns {@code true} if this list
contained the specified element (or equivalently, if this list
changed as a result of the call). |
public E remove(int index) {
checkElementIndex(index);
return unlink(node(index));
}
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. |
public E removeFirst() {
final Node< E > f = first;
if (f == null)
throw new NoSuchElementException();
return unlinkFirst(f);
}
Removes and returns the first element from this list. |
public boolean removeFirstOccurrence(Object o) {
return remove(o);
}
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. |
public E removeLast() {
final Node< E > l = last;
if (l == null)
throw new NoSuchElementException();
return unlinkLast(l);
}
Removes and returns the last element from this list. |
public boolean removeLastOccurrence(Object o) {
if (o == null) {
for (Node< E > x = last; x != null; x = x.prev) {
if (x.item == null) {
unlink(x);
return true;
}
}
} else {
for (Node< E > x = last; x != null; x = x.prev) {
if (o.equals(x.item)) {
unlink(x);
return true;
}
}
}
return false;
}
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. |
public E set(int index,
E element) {
checkElementIndex(index);
Node< E > x = node(index);
E oldVal = x.item;
x.item = element;
return oldVal;
}
Replaces the element at the specified position in this list with the
specified element. |
public int size() {
return size;
}
Returns the number of elements in this list. |
public Object[] toArray() {
Object[] result = new Object[size];
int i = 0;
for (Node< E > x = first; x != null; x = x.next)
result[i++] = x.item;
return result;
}
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. |
public T[] toArray(T[] a) {
if (a.length < size)
a = (T[])java.lang.reflect.Array.newInstance(
a.getClass().getComponentType(), size);
int i = 0;
Object[] result = a;
for (Node< E > x = first; x != null; x = x.next)
result[i++] = x.item;
if (a.length > size)
a[size] = null;
return a;
}
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 {@code 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() 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 {@code 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 {@code String}:
String[] y = x.toArray(new String[0]);
Note that {@code toArray(new Object[0])} is identical in function to
{@code toArray()}. |
E unlink(Node<E> x) {
// assert x != null;
final E element = x.item;
final Node< E > next = x.next;
final Node< E > prev = x.prev;
if (prev == null) {
first = next;
} else {
prev.next = next;
x.prev = null;
}
if (next == null) {
last = prev;
} else {
next.prev = prev;
x.next = null;
}
x.item = null;
size--;
modCount++;
return element;
}
|