coins.aflow.util
Class CoinsList

java.lang.Object
  coins.aflow.util.CoinsList

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.util.List

Direct Known Subclasses:

CoinsList.SubList, SetRefReprList

public class CoinsList

extends java.lang.Object

implements java.lang.Cloneable, java.util.List

List whose iterator implements CoinsIterator (returned by coinsIterator()). This list maintains the list of CoinsIterator this list has, and every such iterator will be notified when there is a structural modification to this list.

See Also:

LinkedList

Nested Class Summary

protected static class	CoinsList.Entry
protected class	CoinsList.Itr
(package private) class	CoinsList.SubList

Field Summary

protected java.util.List	fIterators
protected CoinsList.Entry	header
protected int	modCount Not used in this class.
protected int	size

Constructor Summary

CoinsList()
Constructs an empty list.

CoinsList(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.
protected CoinsList.Entry	addBefore(java.lang.Object o, CoinsList.Entry e, int pIndex)
void	addFirst(java.lang.Object o) Inserts the given element at the beginning of this list.
void	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 LinkedList.
CoinsIterator	coinsIterator() Returns a CoinsIterator object backed by this list, whose cursor is placed at the beginning of this list.
CoinsIterator	coinsIterator(int pIndex) Returns a CoinsIterator object backed by this list, whose cursor is placed before the given index.
boolean	contains(java.lang.Object o) Returns true if this list contains the specified element.
boolean	containsAll(java.util.Collection c)
protected CoinsList.Entry	entry(int index) Return the indexed entry.
boolean	equals(java.lang.Object o)
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	hashCode()
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.
boolean	isEmpty()
java.util.Iterator	iterator()
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()
java.util.ListIterator	listIterator(int index)
protected void	notifyIteratorsOfAddition(int pIndex) Notify all the iterators of this list of the addition of an element at point pIndex to this list, so that they can adjust their current positions if necessary.
protected void	notifyIteratorsOfClearance() Notify all the iterators of this list of the clearance of this list, so that they can initialize.
protected void	notifyIteratorsOfRemoval(CoinsList.Entry e, int pIndex) Notify all the iterators of this list of the removal of an element at the specified position to this list, so that they can adjust their current states.
protected void	remove(CoinsList.Entry e, int pIndex)
java.lang.Object	remove(int index) Removes the element at the specified position in this list.
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element in this list.
boolean	removeAll(java.util.Collection c)
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.
boolean	retainAll(java.util.Collection c)
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.util.List	subList(int fromIndex, int toIndex)
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

header

protected transient CoinsList.Entry header

size

protected transient int size

fIterators

protected java.util.List fIterators

modCount

protected int modCount

Not used in this class.

Constructor Detail

CoinsList

public CoinsList()

Constructs an empty list.

CoinsList

public CoinsList(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.

Parameters:

c - the collection whose elements are to be placed into this list.

Method Detail

getFirst

public java.lang.Object getFirst()

Returns the first element in this list.

Returns:

the first element in this list.

getLast

public java.lang.Object getLast()

Returns the last element in this list.

Returns:

the last element in this list.

Throws:

java.util.NoSuchElementException - if this list is empty.

removeFirst

public java.lang.Object removeFirst()

Removes and returns the first element from this list.

Returns:

the first element from this list.

Throws:

java.util.NoSuchElementException - if this list is empty.

removeLast

public java.lang.Object removeLast()

Removes and returns the last element from this list.

Returns:

the last element from this list.

Throws:

java.util.NoSuchElementException - if this list is empty.

addFirst

public void addFirst(java.lang.Object o)

Inserts the given element at the beginning of this list.

Parameters:

o - the element to be inserted at the beginning of this list.

addLast

public void addLast(java.lang.Object o)

Appends the given element to the end of this list. (Identical in function to the add method; included only for consistency.)

Parameters:

o - the element to be inserted at the end of this list.

contains

public boolean contains(java.lang.Object o)

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 (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface java.util.List

Parameters:

o - element whose presence in this list is to be tested.

Returns:

true if this list contains the specified element.

size

public int size()

Returns the number of elements in this list.

Specified by:

size in interface java.util.List

Returns:

the number of elements in this list.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.List

add

public boolean add(java.lang.Object o)

Appends the specified element to the end of this list.

Specified by:

add in interface java.util.List

Parameters:

o - element to be appended to this list.

Returns:

true (as per the general contract of Collection.add).

remove

public boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element in this list. If the list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists).

Specified by:

remove in interface java.util.List

Parameters:

o - element to be removed from this list, if present.

Returns:

true if the list contained the specified element.

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.List

addAll

public 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. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified Collection is this list, and this list is nonempty.)

Specified by:

addAll in interface java.util.List

Parameters:

c - the elements to be inserted into this list.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index > size()).

addAll

public 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. 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.

Specified by:

addAll in interface java.util.List

Parameters:

index - index at which to insert first element from the specified collection.

c - elements to be inserted into this list.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index > size()).

removeAll

public boolean removeAll(java.util.Collection c)

Specified by:

removeAll in interface java.util.List

retainAll

public boolean retainAll(java.util.Collection c)

Specified by:

retainAll in interface java.util.List

clear

public void clear()

Removes all of the elements from this list.

Specified by:

clear in interface java.util.List

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.List

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.List

get

public java.lang.Object get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface java.util.List

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is is out of range (index < 0 || index >= size()).

set

public java.lang.Object set(int index,
                            java.lang.Object element)

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

Specified by:

set in interface java.util.List

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

Returns:

the element previously at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index >= size()).

add

public void add(int index,
                java.lang.Object element)

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).

Specified by:

add in interface java.util.List

Parameters:

index - index at which the specified element is to be inserted.

element - element to be inserted.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index > size()).

remove

public java.lang.Object remove(int 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.

Specified by:

remove in interface java.util.List

Parameters:

index - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

java.lang.IndexOutOfBoundsException - if the specified index is out of range (index < 0 || index >= size()).

entry

protected CoinsList.Entry entry(int index)

Return the indexed entry.

indexOf

public 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. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface java.util.List

Parameters:

o - element to search for.

Returns:

the index in this list of the first occurrence of the specified element, or -1 if the list does not contain this element.

lastIndexOf

public 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. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface java.util.List

Parameters:

o - element to search for.

Returns:

the index in this list of the last occurrence of the specified element, or -1 if the list does not contain this element.

iterator

public java.util.Iterator iterator()

Specified by:

iterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator()

Specified by:

listIterator in interface java.util.List

listIterator

public java.util.ListIterator listIterator(int index)

Specified by:

listIterator in interface java.util.List

coinsIterator

public CoinsIterator coinsIterator()

Returns a CoinsIterator object backed by this list, whose cursor is placed at the beginning of this list.

coinsIterator

public CoinsIterator coinsIterator(int pIndex)

Returns a CoinsIterator object backed by this list, whose cursor is placed before the given index. Subsequent call to next will return the pIndexth element of this list.

notifyIteratorsOfAddition

protected void notifyIteratorsOfAddition(int pIndex)

Notify all the iterators of this list of the addition of an element at point pIndex to this list, so that they can adjust their current positions if necessary.

notifyIteratorsOfClearance

protected void notifyIteratorsOfClearance()

Notify all the iterators of this list of the clearance of this list, so that they can initialize.

notifyIteratorsOfRemoval

protected void notifyIteratorsOfRemoval(CoinsList.Entry e,
                                        int pIndex)

Notify all the iterators of this list of the removal of an element at the specified position to this list, so that they can adjust their current states.

addBefore

protected CoinsList.Entry addBefore(java.lang.Object o,
                                    CoinsList.Entry e,
                                    int pIndex)

remove

protected void remove(CoinsList.Entry e,
                      int pIndex)

clone

public java.lang.Object clone()

Returns a shallow copy of this LinkedList. (The elements themselves are not cloned.)

Returns:

a shallow copy of this LinkedList instance.

toArray

public java.lang.Object[] toArray()

Returns an array containing all of the elements in this list in the correct order.

Specified by:

toArray in interface java.util.List

Returns:

an array containing all of the elements in this list in the correct order.

toArray

public 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. 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 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.

Specified by:

toArray in interface java.util.List

Parameters:

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.

Returns:

an array containing the elements of the list.

Throws:

java.lang.ArrayStoreException - if the runtime type of a is not a supertype of the runtime type of every element in this list.

subList

public java.util.List subList(int fromIndex,
                              int toIndex)

Specified by:

subList in interface java.util.List

toString

public java.lang.String toString()