|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.AbstractSequentialList
org.aris.maps.lists.LinkedListEx
public class LinkedListEx
Linked list implementation of the List interface. Implements all optional list operations, and permits all elements (including null). In addition to implementing the List interface, the LinkedListEx class provides uniformly named methods to get,remove and insert an element at the beginning and end of the list. These operations allow linked lists to be used as a stack, queue, or double-ended queue (deque).
All of the stack/queue/deque operations could be easily recast in terms of the standard list operations. They're included here primarily for convenience, though they may run slightly faster than the equivalent List operations.
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 begining or the end, whichever is closer to the specified index.
Note that this implementation is not synchronized. If multiple threads access a 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 method. This is best done at creation time, to prevent accidental unsynchronized access to the list:
List list = Collections.synchronizedList(new LinkedListEx(...));
The iterators returned by the 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. 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 .
List
,
ArrayList
,
Vector
,
Collections.synchronizedList(List)
,
Serialized FormConstructor Summary | |
---|---|
LinkedListEx()
Constructs an empty list. |
|
LinkedListEx(java.util.Collection c)
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. |
Method Summary | |
---|---|
void |
add(int index,
java.lang.Object element)
Inserts the specified element at the specified position in this list. |
boolean |
add(java.lang.Object o)
Appends the specified element to the end of this list. |
boolean |
addAll(java.util.Collection 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. |
boolean |
addAll(int index,
java.util.Collection c)
Inserts all of the elements in the specified collection into this list, starting at the specified position. |
LinkedListExEntry |
addBefore(java.lang.Object o,
LinkedListExEntry e)
|
LinkedListExEntry |
addFirst(java.lang.Object o)
Inserts the given element at the beginning of this list. |
LinkedListExEntry |
addLast(java.lang.Object o)
Appends the given element to the end of this list. |
void |
clear()
Removes all of the elements from this list. |
java.lang.Object |
clone()
Returns a shallow copy of this LinkedListEx. |
boolean |
contains(java.lang.Object o)
Returns true if this list contains the specified element. |
java.lang.Object |
get(int index)
Returns the element at the specified position in this list. |
java.lang.Object |
getFirst()
Returns the first element in this list. |
java.lang.Object |
getLast()
Returns the last element in this list. |
int |
indexOf(java.lang.Object o)
Returns the index in this list of the first occurrence of the specified element, or -1 if the List does not contain this element. |
int |
lastIndexOf(java.lang.Object o)
Returns the index in this list of the last occurrence of the specified element, or -1 if the list does not contain this element. |
java.util.ListIterator |
listIterator(int index)
Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list. |
java.lang.Object |
remove(int index)
Removes the element at the specified position in this list. |
void |
remove(LinkedListExEntry e)
|
boolean |
remove(java.lang.Object o)
Removes the first occurrence of the specified element in this list. |
java.lang.Object |
removeFirst()
Removes and returns the first element from this list. |
java.lang.Object |
removeLast()
Removes and returns the last element from this list. |
java.lang.Object |
set(int index,
java.lang.Object element)
Replaces the element at the specified position in this list with the specified element. |
int |
size()
Returns the number of elements in this list. |
java.lang.Object[] |
toArray()
Returns an array containing all of the elements in this list in the correct order. |
java.lang.Object[] |
toArray(java.lang.Object[] a)
Returns an array containing all of the elements in this list in the correct order; the runtime type of the returned array is that of the specified array. |
Methods inherited from class java.util.AbstractSequentialList |
---|
iterator |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode, listIterator, subList |
Methods inherited from class java.util.AbstractCollection |
---|
containsAll, isEmpty, removeAll, retainAll, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, retainAll, subList |
Constructor Detail |
---|
public LinkedListEx()
public LinkedListEx(java.util.Collection c)
c
- the collection whose elements are to be placed into this list.
java.lang.NullPointerException
- if the specified collection is null.Method Detail |
---|
public java.lang.Object getFirst()
java.util.NoSuchElementException
- if this list is empty.public java.lang.Object getLast()
java.util.NoSuchElementException
- if this list is empty.public java.lang.Object removeFirst()
java.util.NoSuchElementException
- if this list is empty.public java.lang.Object removeLast()
java.util.NoSuchElementException
- if this list is empty.public LinkedListExEntry addFirst(java.lang.Object o)
o
- the element to be inserted at the beginning of this list.public LinkedListExEntry addLast(java.lang.Object o)
o
- the element to be inserted at the end of this list.public boolean contains(java.lang.Object o)
contains
in interface java.util.Collection
contains
in interface java.util.List
contains
in class java.util.AbstractCollection
o
- element whose presence in this list is to be tested.
public int size()
size
in interface java.util.Collection
size
in interface java.util.List
size
in class java.util.AbstractCollection
public boolean add(java.lang.Object o)
add
in interface java.util.Collection
add
in interface java.util.List
add
in class java.util.AbstractList
o
- element to be appended to this list.
public boolean remove(java.lang.Object o)
remove
in interface java.util.Collection
remove
in interface java.util.List
remove
in class java.util.AbstractCollection
o
- element to be removed from this list, if present.
public boolean addAll(java.util.Collection c)
addAll
in interface java.util.Collection
addAll
in interface java.util.List
addAll
in class java.util.AbstractCollection
c
- the elements to be inserted into this list.
java.lang.NullPointerException
- if the specified collection is null.public boolean addAll(int index, java.util.Collection c)
addAll
in interface java.util.List
addAll
in class java.util.AbstractSequentialList
index
- index at which to insert first element from the specified
collection.c
- elements to be inserted into this list.
java.lang.IndexOutOfBoundsException
- if the specified index is out of range (
index < 0 || index > size()).
java.lang.NullPointerException
- if the specified collection is null.public void clear()
clear
in interface java.util.Collection
clear
in interface java.util.List
clear
in class java.util.AbstractList
public java.lang.Object get(int index)
get
in interface java.util.List
get
in class java.util.AbstractSequentialList
index
- index of element to return.
java.lang.IndexOutOfBoundsException
- if the specified index is is out of range (
index < 0 || index >= size()).public java.lang.Object set(int index, java.lang.Object element)
set
in interface java.util.List
set
in class java.util.AbstractSequentialList
index
- index of element to replace.element
- element to be stored at the specified position.
java.lang.IndexOutOfBoundsException
- if the specified index is out of range (
index < 0 || index >= size()).public void add(int index, java.lang.Object element)
add
in interface java.util.List
add
in class java.util.AbstractSequentialList
index
- index at which the specified element is to be inserted.element
- element to be inserted.
java.lang.IndexOutOfBoundsException
- if the specified index is out of range (
index < 0 || index > size()).public java.lang.Object remove(int index)
remove
in interface java.util.List
remove
in class java.util.AbstractSequentialList
index
- the index of the element to removed.
java.lang.IndexOutOfBoundsException
- if the specified index is out of range (
index < 0 || index >= size()).public int indexOf(java.lang.Object o)
indexOf
in interface java.util.List
indexOf
in class java.util.AbstractList
o
- element to search for.
public int lastIndexOf(java.lang.Object o)
lastIndexOf
in interface java.util.List
lastIndexOf
in class java.util.AbstractList
o
- element to search for.
public java.util.ListIterator listIterator(int index)
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.
listIterator
in interface java.util.List
listIterator
in class java.util.AbstractSequentialList
index
- index of first element to be returned from the list-iterator
(by a call to next).
java.lang.IndexOutOfBoundsException
- if index is out of range (
index < 0 || index > size()).List.listIterator(int)
public LinkedListExEntry addBefore(java.lang.Object o, LinkedListExEntry e)
public void remove(LinkedListExEntry e)
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.Object[] toArray()
toArray
in interface java.util.Collection
toArray
in interface java.util.List
toArray
in class java.util.AbstractCollection
public java.lang.Object[] toArray(java.lang.Object[] a)
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 collection 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.
toArray
in interface java.util.Collection
toArray
in interface java.util.List
toArray
in class java.util.AbstractCollection
a
- the array into which the elements of the list are to be
stored, if it is big enough; otherwise, a new array of the
same runtime type is allocated for this purpose.
java.lang.ArrayStoreException
- if the runtime type of a is not a supertype of the runtime
type of every element in this list.
java.lang.NullPointerException
- if the specified array is null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |