List
interface. Implements
all optional list operations, and permits all elements, including
null
. In addition to implementing the List
interface,
this class provides methods to manipulate the size of the array that is
used internally to store the list. (This class is roughly equivalent to
Vector
, except that it is unsynchronized.)
The size
, isEmpty
, get
, set
,
iterator
, and listIterator
operations run in constant
time. The add
operation runs in amortized constant time,
that is, adding n elements requires O(n) time. All of the other operations
run in linear time (roughly speaking). The constant factor is low compared
to that for the LinkedList
implementation.
Each IdentityArrayList
instance has a capacity. The capacity is
the size of the array used to store the elements in the list. It is always
at least as large as the list size. As elements are added to an IdentityArrayList,
its capacity grows automatically. The details of the growth policy are not
specified beyond the fact that adding an element has constant amortized
time cost.
An application can increase the capacity of an IdentityArrayList
instance
before adding a large number of elements using the ensureCapacity
operation. This may reduce the amount of incremental reallocation.
Note that this implementation is not synchronized.
If multiple threads access an IdentityArrayList
instance 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, or explicitly
resizes the backing array; 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.
method. This is best done at creation time, to prevent accidental
unsynchronized access to the list:
List list = Collections.synchronizedList(new IdentityArrayList(...));
The iterators returned by 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.
Modifier and Type | Field and Description |
---|---|
private transient Object[] | elementData
The array buffer into which the elements of the IdentityArrayList are stored. |
private int | size
The size of the IdentityArrayList (the number of elements it contains). |
Access | Constructor and Description |
---|---|
public | IdentityArrayList(int
the initial capacity of the list initialCapacity)Constructs an empty list with the specified initial capacity. |
public | |
public | IdentityArrayList(Collection<? extends E>
the collection whose elements are to be placed into this list c)Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. |
Modifier and Type | Method and Description |
---|---|
public boolean | add(E
element to be appended to this list e)Overrides java. Implements java. |
public void | add(int
index at which the specified element is to be inserted index, E element to be inserted element)Overrides java. Implements java. |
public boolean | Returns: true if this list changed as a result of the callcollection containing elements to be added to this list c)Overrides java. Implements java. |
public boolean | Returns: true if this list changed as a result of the callindex at which to insert the first element from the
specified collection index, Collection<? extends E> collection containing elements to be added to this list c)Overrides java. Implements java. |
public void | clear()
Overrides java. Implements java. |
public boolean | Returns: true if this list contains the specified elementelement whose presence in this list is to be tested o)Overrides java. Implements java. true if this list contains the specified element.
|
public void | ensureCapacity(int
the desired minimum capacity minCapacity)Increases the capacity of this |
private void | |
public E | Returns: the element at the specified position in this listindex of the element to return index)Implements abstract java. Implements java. |
public int | Returns: the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the elementelement to search for o)Overrides java. Implements java. |
public boolean | Returns: true if this list contains no elementsOverrides java. Implements java. true if this list contains no elements.
|
public int | Returns: the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the elementelement to search for o)Overrides java. Implements java. |
private String | outOfBoundsMsg(int index)
Constructs an IndexOutOfBoundsException detail message.
|
private void | |
private void | rangeCheckForAdd(int index)
A version of rangeCheck used by add and addAll.
|
public E | Returns: the element that was removed from the listthe index of the element to be removed index)Overrides java. Implements java. |
public boolean | Returns: true if this list contained the specified elementelement to be removed from this list, if present o)Overrides java. Implements java. |
protected void | removeRange(int
index of first element to be removed fromIndex, int index after last element to be removed toIndex)Overrides java. fromIndex , inclusive, and toIndex , exclusive.
|
public E | Returns: the element previously at the specified positionindex of the element to replace index, E element to be stored at the specified position element)Overrides java. Implements java. |
public int | Returns: the number of elements in this listImplements abstract java. Implements java. |
public Object[] | Returns: an array containing all of the elements in this list in proper sequenceOverrides java. Implements java. |
public <T> T[] | Returns: an array containing the elements of the listthe 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. a)Overrides java. Implements java. |
public void |
elementData | back to summary |
---|---|
private transient Object[] elementData The array buffer into which the elements of the IdentityArrayList are stored. The capacity of the IdentityArrayList is the length of this array buffer. |
size | back to summary |
---|---|
private int size The size of the IdentityArrayList (the number of elements it contains). |
IdentityArrayList | back to summary |
---|---|
public IdentityArrayList(int initialCapacity) Constructs an empty list with the specified initial capacity.
|
IdentityArrayList | back to summary |
---|---|
public IdentityArrayList() Constructs an empty list with an initial capacity of ten. |
IdentityArrayList | back to summary |
---|---|
public IdentityArrayList(Collection<? extends E> c) Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
|
add | back to summary |
---|---|
public boolean add(E e) Overrides java. Implements java. Appends the specified element to the end of this list.
|
add | back to summary |
---|---|
public void add(int index, E element) Overrides java. Implements java. 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).
|
addAll | back to summary |
---|---|
public boolean addAll(Collection<? extends E> c) Overrides java. Implements java. 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.)
|
addAll | back to summary |
---|---|
public boolean addAll(int index, Collection<? extends E> c) Overrides java. Implements java. 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.
|
clear | back to summary |
---|---|
public void clear() Overrides java. Implements java. Removes all of the elements from this list. The list will be empty after this call returns. |
contains | back to summary |
---|---|
public boolean contains(Object o) Overrides java. Implements java. Returns
|
ensureCapacity | back to summary |
---|---|
public void ensureCapacity(int minCapacity) Increases the capacity of this
|
fastRemove | back to summary |
---|---|
private void fastRemove(int index) |
get | back to summary |
---|---|
public E get(int index) Implements abstract java. Implements java. Returns the element at the specified position in this list.
|
indexOf | back to summary |
---|---|
public int indexOf(Object o) Overrides java. Implements java. 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
|
isEmpty | back to summary |
---|---|
public boolean isEmpty() Overrides java. Implements java. Returns
|
lastIndexOf | back to summary |
---|---|
public int lastIndexOf(Object o) Overrides java. Implements java. 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
|
outOfBoundsMsg | back to summary |
---|---|
private String outOfBoundsMsg(int index) Hides java. Constructs an IndexOutOfBoundsException detail message. Of the many possible refactorings of the error handling code, this "outlining" performs best with both server and client VMs. |
rangeCheck | back to summary |
---|---|
private void rangeCheck(int index) Checks if the given index is in range. If not, throws an appropriate runtime exception. This method does *not* check if the index is negative: It is always used immediately prior to an array access, which throws an ArrayIndexOutOfBoundsException if index is negative. |
rangeCheckForAdd | back to summary |
---|---|
private void rangeCheckForAdd(int index) Hides java. A version of rangeCheck used by add and addAll. |
remove | back to summary |
---|---|
public E remove(int index) Overrides java. Implements java. Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
|
remove | back to summary |
---|---|
public boolean remove(Object o) Overrides java. Implements java. Removes the first occurrence of the specified element from this list,
if it is present. If this list does not contain the element, the list is
unchanged. More formally, removes the element with the lowest index
|
removeRange | back to summary |
---|---|
protected void removeRange(int fromIndex, int toIndex) Overrides java. Removes from this list all of the elements whose index is between
|
set | back to summary |
---|---|
public E set(int index, E element) Overrides java. Implements java. Replaces the element at the specified position in this list with the specified element.
|
size | back to summary |
---|---|
public int size() Implements abstract java. Implements java. Returns the number of elements in this list.
|
toArray | back to summary |
---|---|
public Object[] toArray() Overrides java. Implements java. 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.
|
toArray | back to summary |
---|---|
public <T> T[] toArray(T[] a) Overrides java. Implements java. 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 collection is set to
|
trimToSize | back to summary |
---|---|
public void trimToSize() Trims the capacity of this |