Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
EDU.oswego.cs.dl.util.concurrent.CopyOnWriteArrayList
CopyOnWriteArraySet
, Serialized FormNested Class Summary | |
protected static class | |
protected static class |
Field Summary | |
protected Object[] |
|
Constructor Summary | |
| |
| |
|
Method Summary | |
boolean |
|
void |
|
boolean |
|
boolean |
|
int |
|
boolean |
|
protected Object[] |
|
void |
|
Object |
|
boolean |
|
boolean |
|
void |
|
boolean |
|
Object |
|
int |
|
int |
|
protected static int |
|
int |
|
boolean |
|
Iterator |
|
int |
|
protected static int |
|
int |
|
ListIterator |
|
ListIterator |
|
protected void |
|
boolean |
|
Object |
|
boolean |
|
void |
|
boolean |
|
Object |
|
int |
|
List |
|
Object[] |
|
Object[] |
|
String |
|
public CopyOnWriteArrayList()
Constructs an empty list
public CopyOnWriteArrayList(Collection c)
Constructs an list containing the elements of the specified Collection, in the order they are returned by the Collection's iterator.
public CopyOnWriteArrayList(Object[] toCopyIn)
Create a new CopyOnWriteArrayList holding a copy of given array
- Parameters:
toCopyIn
- the array. A copy of this array is used as the internal array.
public boolean add(Object element)
Appends the specified element to the end of this list.
- Parameters:
element
- element to be appended to this list.
- Returns:
- true (as per the general contract of Collection.add).
public void add(int index, 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).
- Parameters:
index
- index at which the specified element is to be inserted.element
- element to be inserted.
public boolean addAll(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.
- Parameters:
c
- elements to be inserted into this list.
public boolean addAll(int index, 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.
- Parameters:
index
- index at which to insert first element from the specified collection.c
- elements to be inserted into this list.
public int addAllAbsent(Collection c)
Appends all of the elements in the specified Collection that are not already contained in this list, to the end of this list, in the order that they are returned by the specified Collection's Iterator.
- Parameters:
c
- elements to be added into this list.
- Returns:
- the number of elements added
public boolean addIfAbsent(Object element)
Append the element if not present. This operation can be used to obtain Set semantics for lists.
- Parameters:
element
- element to be added to this Collection, if absent.
- Returns:
- true if added
protected Object[] array()
Accessor to the array intended to be called from within unsynchronized read-only methods
public void clear()
Removes all of the elements from this list.
public Object clone()
Returns a shallow copy of this list. (The elements themselves are not copied.)
- Returns:
- a clone of this list.
public boolean contains(Object elem)
Returns true if this list contains the specified element.
- Parameters:
public boolean containsAll(Collection c)
Returns true if this Collection contains all of the elements in the specified Collection. This implementation iterates over the specified Collection, checking each element returned by the Iterator in turn to see if it's contained in this Collection. If all elements are so contained true is returned, otherwise false.
public void copyIn(Object[] toCopyIn, int first, int n)
Replace the held array with a copy of then
elements of the provided array, starting at positionfirst
. To copy an entire array, call with arguments (array, 0, array.length).
- Parameters:
toCopyIn
- the array. A copy of the indicated elements of this array is used as the internal array.first
- The index of first position of the array to start copying from.n
- the number of elements to copy. This will be the new size of the list.
public boolean equals(Object o)
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 elementse1
ande2
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. This implementation first checks if the specified object is this List. If so, it returns true; if not, it checks if the specified object is a List. If not, it returns false; if so, it iterates over both lists, comparing corresponding pairs of elements. If any comparison returns false, this method returns false. If either Iterator runs out of elements before before the other it returns false (as the Lists are of unequal length); otherwise it returns true when the iterations complete.
- Parameters:
o
- the Object to be compared for equality with this List.
- Returns:
- true if the specified Object is equal to this List.
public Object get(int index)
Returns the element at the specified position in this list.
- Parameters:
index
- index of element to return.
public int hashCode()
Returns the hash code value for this List. This implementation uses exactly the code that is used to define the List hash function in the documentation for List.hashCode.
public int indexOf(Object elem)
Searches for the first occurence of the given argument, testing for equality using theequals
method.
- Parameters:
elem
- an object.
- Returns:
- the index of the first occurrence of the argument in this list; returns
-1
if the object is not found.
- See Also:
Object.equals(Object)
protected static int indexOf(Object elem, Object[] elementData, int len)
static version allows repeated call without needed to grab lock for array each time
public int indexOf(Object elem, int index)
Searches for the first occurence of the given argument, beginning the search atindex
, and testing for equality using theequals
method.
- Parameters:
elem
- an object.index
- the index to start searching from.
- Returns:
- the index of the first occurrence of the object argument in this List at position
index
or later in the List; returns-1
if the object is not found.
- See Also:
Object.equals(Object)
public boolean isEmpty()
Tests if this list has no components.
- Returns:
true
if this list has no components;false
otherwise.
public Iterator iterator()
Returns an Iterator over the elements contained in this collection. The iterator provides a snapshot of the state of the list when the iterator was constructed. No synchronization is needed while traversing the iterator. The iterator does NOT support theremove
method.
public int lastIndexOf(Object elem)
Returns the index of the last occurrence of the specified object in this list.
- Parameters:
elem
- the desired component.
- Returns:
- the index of the last occurrence of the specified object in this list; returns -1 if the object is not found.
protected static int lastIndexOf(Object elem, Object[] elementData, int len)
public int lastIndexOf(Object elem, int index)
Searches backwards for the specified object, starting from the specified index, and returns an index to it.
- Parameters:
elem
- the desired component.index
- the index to start searching from.
- Returns:
- the index of the last occurrence of the specified object in this List at position less than index in the List; -1 if the object is not found.
public ListIterator listIterator()
Returns an Iterator of the elements in this List (in proper sequence). The iterator provides a snapshot of the state of the list when the iterator was constructed. No synchronization is needed while traversing the iterator. The iterator does NOT support theremove
,set
, oradd
methods.
public ListIterator listIterator(int index)
Returns a ListIterator of the elements in this List (in proper sequence), starting at the specified position in the List. The specified index indicates the first element that would be returned by an initial call to nextElement. An initial call to previousElement would return the element with the specified index minus one. The ListIterator returned by this implementation will throw an UnsupportedOperationException in its remove, set and add methods.
- Parameters:
index
- index of first element to be returned from the ListIterator (by a call to getNext).
protected void rangeCheck(int index, int length)
Check if the given index is in range. If not, throw an appropriate runtime exception.
public boolean remove(Object element)
Removes a single instance of the specified element from this Collection, if it is present (optional operation). More formally, removes an elemente
such that(o==null ? e==null : o.equals(e))
, if the Collection contains one or more such elements. Returns true if the Collection contained the specified element (or equivalently, if the Collection changed as a result of the call).
- Parameters:
element
- element to be removed from this Collection, if present.
- Returns:
- true if the Collection changed as a result of the call.
public 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.
- Parameters:
index
- the index of the element to removed.
public boolean removeAll(Collection c)
Removes from this Collection all of its elements that are contained in the specified Collection. This is a particularly expensive operation in this class because of the need for an internal temporary array.
- Returns:
- true if this Collection changed as a result of the call.
public void removeRange(int fromIndex, int toIndex)
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.)
- Parameters:
fromIndex
- index of first element to be removed.
public boolean retainAll(Collection c)
Retains only the elements in this Collection that are contained in the specified Collection (optional operation). In other words, removes from this Collection all of its elements that are not contained in the specified Collection.
- Returns:
- true if this Collection changed as a result of the call.
public Object set(int index, Object element)
Replaces the element at the specified position in this list with the specified element.
- Parameters:
index
- index of element to replace.element
- element to be stored at the specified position.
- Returns:
- the element previously at the specified position.
public int size()
Returns the number of components in this list.
- Returns:
- the number of components in this list.
public List subList(int fromIndex, int toIndex)
Returns a view of the portion of this List between fromIndex, inclusive, and toIndex, exclusive. The returned List is backed by this List, so changes in the returned List are reflected in this List, and vice-versa. While mutative operations are supported, they are probably not very useful for CopyOnWriteArrays. The semantics of the List returned by this method become undefined if the backing list (i.e., this List) is structurally modified in any way other than via the returned List. (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.)
- Parameters:
fromIndex
- low endpoint (inclusive) of the subList.
- Returns:
- a view of the specified range within this List.
public Object[] toArray()
Returns an array containing all of the elements in this list in the correct order.
public Object[] toArray(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.
- Parameters:
- Returns:
- an array containing the elements of the list.
public String toString()
Returns a string representation of this Collection, containing the String representation of each element.