org.compass.core.util.backport.java.util
Class LinkedList

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.AbstractSequentialList
              org.compass.core.util.backport.java.util.LinkedList

All Implemented Interfaces:

Serializable, Cloneable, Iterable, Collection, List, Deque, Queue

public class LinkedList
extends AbstractSequentialList
implements List, Deque, Cloneable, Serializable

See Also:

Serialized Form

Constructor Summary

LinkedList()

LinkedList(Collection c)

Method Summary

void	add(int index, Object element)
boolean	add(Object o) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
boolean	addAll(Collection c)
boolean	addAll(int index, Collection c)
void	addFirst(Object e) Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions.
void	addLast(Object e) Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions.
void	clear()
Object	clone()
boolean	contains(Object o) Returns true if this deque contains the specified element.
Iterator	descendingIterator() Returns an iterator over the elements in this deque in reverse sequential order.
Object	element() Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque).
Object	get(int index)
Object	getFirst() Retrieves, but does not remove, the first element of this deque.
Object	getLast() Retrieves, but does not remove, the last element of this deque.
int	indexOf(Object o)
boolean	isEmpty()
int	lastIndexOf(Object o)
ListIterator	listIterator()
ListIterator	listIterator(int index)
boolean	offer(Object e) Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available.
boolean	offerFirst(Object e) Inserts the specified element at the front of this deque unless it would violate capacity restrictions.
boolean	offerLast(Object e) Inserts the specified element at the end of this deque unless it would violate capacity restrictions.
Object	peek() Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.
Object	peekFirst() Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.
Object	peekLast() Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.
Object	poll() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.
Object	pollFirst() Retrieves and removes the first element of this deque, or returns null if this deque is empty.
Object	pollLast() Retrieves and removes the last element of this deque, or returns null if this deque is empty.
Object	pop() Pops an element from the stack represented by this deque.
void	push(Object e) Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
Object	remove() Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque).
Object	remove(int index)
boolean	remove(Object o) Removes the first occurrence of the specified element from this deque.
Object	removeFirst() Retrieves and removes the first element of this deque.
boolean	removeFirstOccurrence(Object o) Removes the first occurrence of the specified element from this deque.
Object	removeLast() Retrieves and removes the last element of this deque.
boolean	removeLastOccurrence(Object o) Removes the last occurrence of the specified element from this deque.
Object	set(int index, Object element)
int	size() Returns the number of elements in this deque.
Object[]	toArray()
Object[]	toArray(Object[] a)

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, iterator, removeAll, retainAll, subList

Methods inherited from interface org.compass.core.util.backport.java.util.Deque

iterator

Constructor Detail

LinkedList

public LinkedList()

LinkedList

public LinkedList(Collection c)

Method Detail

size

public int size()

Description copied from interface: Deque

Returns the number of elements in this deque.

Specified by:

size in interface Collection

Specified by:

size in interface List

Specified by:

size in interface Deque

Specified by:

size in class AbstractCollection

Returns:

the number of elements in this deque

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Specified by:

isEmpty in interface List

Overrides:

isEmpty in class AbstractCollection

contains

public boolean contains(Object o)

Description copied from interface: Deque

Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface Collection

Specified by:

contains in interface List

Specified by:

contains in interface Deque

Overrides:

contains in class AbstractCollection

Parameters:

o - element whose presence in this deque is to be tested

Returns:

true if this deque contains the specified element

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List

Overrides:

indexOf in class AbstractList

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List

Overrides:

lastIndexOf in class AbstractList

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

toArray

public Object[] toArray(Object[] a)

Specified by:

toArray in interface Collection

Specified by:

toArray in interface List

Overrides:

toArray in class AbstractCollection

add

public boolean add(Object o)

Description copied from interface: Deque

Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use offer.

This method is equivalent to Deque.addLast(java.lang.Object).

Specified by:

add in interface Collection

Specified by:

add in interface List

Specified by:

add in interface Deque

Specified by:

add in interface Queue

Overrides:

add in class AbstractList

Parameters:

o - the element to add

Returns:

true (as specified by Collection.add(E))

remove

public boolean remove(Object o)

Description copied from interface: Deque

Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that (o==null ? e==null : o.equals(e)) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

This method is equivalent to Deque.removeFirstOccurrence(java.lang.Object).

Specified by:

remove in interface Collection

Specified by:

remove in interface List

Specified by:

remove in interface Deque

Overrides:

remove in class AbstractCollection

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

addAll

public boolean addAll(Collection c)

Specified by:

addAll in interface Collection

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractCollection

addAll

public boolean addAll(int index,
                      Collection c)

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractSequentialList

clear

public void clear()

Specified by:

clear in interface Collection

Specified by:

clear in interface List

Overrides:

clear in class AbstractList

get

public Object get(int index)

Specified by:

get in interface List

Overrides:

get in class AbstractSequentialList

set

public Object set(int index,
                  Object element)

Specified by:

set in interface List

Overrides:

set in class AbstractSequentialList

add

public void add(int index,
                Object element)

Specified by:

add in interface List

Overrides:

add in class AbstractSequentialList

remove

public Object remove(int index)

Specified by:

remove in interface List

Overrides:

remove in class AbstractSequentialList

listIterator

public ListIterator listIterator()

Specified by:

listIterator in interface List

Overrides:

listIterator in class AbstractList

listIterator

public ListIterator listIterator(int index)

Specified by:

listIterator in interface List

Specified by:

listIterator in class AbstractSequentialList

addFirst

public void addFirst(Object e)

Description copied from interface: Deque

Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method Deque.offerFirst(java.lang.Object).

Specified by:

addFirst in interface Deque

Parameters:

e - the element to add

addLast

public void addLast(Object e)

Description copied from interface: Deque

Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions. When using a capacity-restricted deque, it is generally preferable to use method Deque.offerLast(java.lang.Object).

This method is equivalent to Deque.add(java.lang.Object).

Specified by:

addLast in interface Deque

Parameters:

e - the element to add

offerFirst

public boolean offerFirst(Object e)

Description copied from interface: Deque

Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the Deque.addFirst(java.lang.Object) method, which can fail to insert an element only by throwing an exception.

Specified by:

offerFirst in interface Deque

Parameters:

e - the element to add

Returns:

true if the element was added to this deque, else false

offerLast

public boolean offerLast(Object e)

Description copied from interface: Deque

Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the Deque.addLast(java.lang.Object) method, which can fail to insert an element only by throwing an exception.

Specified by:

offerLast in interface Deque

Parameters:

e - the element to add

Returns:

true if the element was added to this deque, else false

removeFirst

public Object removeFirst()

Description copied from interface: Deque

Retrieves and removes the first element of this deque. This method differs from pollFirst only in that it throws an exception if this deque is empty.

Specified by:

removeFirst in interface Deque

Returns:

the head of this deque

removeLast

public Object removeLast()

Description copied from interface: Deque

Retrieves and removes the last element of this deque. This method differs from pollLast only in that it throws an exception if this deque is empty.

Specified by:

removeLast in interface Deque

Returns:

the tail of this deque

pollFirst

public Object pollFirst()

Description copied from interface: Deque

Retrieves and removes the first element of this deque, or returns null if this deque is empty.

Specified by:

pollFirst in interface Deque

Returns:

the head of this deque, or null if this deque is empty

pollLast

public Object pollLast()

Description copied from interface: Deque

Retrieves and removes the last element of this deque, or returns null if this deque is empty.

Specified by:

pollLast in interface Deque

Returns:

the tail of this deque, or null if this deque is empty

getFirst

public Object getFirst()

Description copied from interface: Deque

Retrieves, but does not remove, the first element of this deque. This method differs from peekFirst only in that it throws an exception if this deque is empty.

Specified by:

getFirst in interface Deque

Returns:

the head of this deque

getLast

public Object getLast()

Description copied from interface: Deque

Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.

Specified by:

getLast in interface Deque

Returns:

the tail of this deque

peekFirst

public Object peekFirst()

Description copied from interface: Deque

Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.

Specified by:

peekFirst in interface Deque

Returns:

the head of this deque, or null if this deque is empty

peekLast

public Object peekLast()

Description copied from interface: Deque

Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.

Specified by:

peekLast in interface Deque

Returns:

the tail of this deque, or null if this deque is empty

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

Description copied from interface: Deque

Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that (o==null ? e==null : o.equals(e)) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

Specified by:

removeFirstOccurrence in interface Deque

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

Description copied from interface: Deque

Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that (o==null ? e==null : o.equals(e)) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

Specified by:

removeLastOccurrence in interface Deque

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

offer

public boolean offer(Object e)

Description copied from interface: Deque

Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the Deque.add(java.lang.Object) method, which can fail to insert an element only by throwing an exception.

This method is equivalent to Deque.offerLast(java.lang.Object).

Specified by:

offer in interface Deque

Specified by:

offer in interface Queue

Parameters:

e - the element to add

Returns:

true if the element was added to this deque, else false

remove

public Object remove()

Description copied from interface: Deque

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll only in that it throws an exception if this deque is empty.

This method is equivalent to Deque.removeFirst().

Specified by:

remove in interface Deque

Specified by:

remove in interface Queue

Returns:

the head of the queue represented by this deque

poll

public Object poll()

Description copied from interface: Deque

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.

This method is equivalent to Deque.pollFirst().

Specified by:

poll in interface Deque

Specified by:

poll in interface Queue

Returns:

the first element of this deque, or null if this deque is empty

element

public Object element()

Description copied from interface: Deque

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

This method is equivalent to Deque.getFirst().

Specified by:

element in interface Deque

Specified by:

element in interface Queue

Returns:

the head of the queue represented by this deque

peek

public Object peek()

Description copied from interface: Deque

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.

This method is equivalent to Deque.peekFirst().

Specified by:

peek in interface Deque

Specified by:

peek in interface Queue

Returns:

the head of the queue represented by this deque, or null if this deque is empty

push

public void push(Object e)

Description copied from interface: Deque

Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.

This method is equivalent to Deque.addFirst(java.lang.Object).

Specified by:

push in interface Deque

Parameters:

e - the element to push

pop

public Object pop()

Description copied from interface: Deque

Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.

This method is equivalent to Deque.removeFirst().

Specified by:

pop in interface Deque

Returns:

the element at the front of this deque (which is the top of the stack represented by this deque)

descendingIterator

public Iterator descendingIterator()

Description copied from interface: Deque

Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).

Specified by:

descendingIterator in interface Deque

Returns:

an iterator over the elements in this deque in reverse sequence

clone

public Object clone()

Overrides:

clone in class Object