|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractCollection<E> java.util.AbstractList<E> java.util.ArrayList<E>
public class ArrayList<E>
Resizable-array implementation of the 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 ArrayList 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 ArrayList, 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 ArrayList 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 ArrayList 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.synchronizedList
method. This is best done at creation time, to prevent accidental
unsynchronized access to the list:
List list = Collections.synchronizedList(new ArrayList(...));
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.
This class is a member of the Java Collections Framework.
Collection
,
List
,
LinkedList
,
Vector
,
Serialized FormField Summary |
---|
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
ArrayList()
Constructs an empty list with an initial capacity of ten. |
|
ArrayList(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. |
|
ArrayList(int initialCapacity)
Constructs an empty list with the specified initial capacity. |
Method Summary | ||
---|---|---|
boolean |
add(E e)
Appends the specified element to the end of this list. |
|
void |
add(int index,
E element)
Inserts the specified element at the specified position in this list. |
|
boolean |
addAll(Collection<? extends E> 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,
Collection<? extends E> c)
Inserts all of the elements in the specified collection into this list, starting at the specified position. |
|
void |
clear()
Removes all of the elements from this list. |
|
Object |
clone()
Returns a shallow copy of this ArrayList instance. |
|
boolean |
contains(Object o)
Returns true if this list contains the specified element. |
|
void |
ensureCapacity(int minCapacity)
Increases the capacity of this ArrayList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument. |
|
E |
get(int index)
Returns the element at the specified position in this list. |
|
int |
indexOf(Object o)
Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. |
|
boolean |
isEmpty()
Returns true if this list contains no elements. |
|
int |
lastIndexOf(Object o)
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. |
|
E |
remove(int index)
Removes the element at the specified position in this list. |
|
boolean |
remove(Object o)
Removes the first occurrence of the specified element from this list, if it is present. |
|
protected void |
removeRange(int fromIndex,
int toIndex)
Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. |
|
E |
set(int index,
E 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. |
|
Object[] |
toArray()
Returns an array containing all of the elements in this list in proper sequence (from first to last element). |
|
|
toArray(T[] a)
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. |
|
void |
trimToSize()
Trims the capacity of this ArrayList instance to be the list's current size. |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode, iterator, listIterator, listIterator, 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, listIterator, listIterator, removeAll, retainAll, subList |
Constructor Detail |
---|
public ArrayList(int initialCapacity)
initialCapacity
- the initial capacity of the list
IllegalArgumentException
- if the specified initial capacity
is negativepublic ArrayList()
public ArrayList(Collection<? extends E> c)
c
- the collection whose elements are to be placed into this list
NullPointerException
- if the specified collection is nullMethod Detail |
---|
public void trimToSize()
public void ensureCapacity(int minCapacity)
minCapacity
- the desired minimum capacitypublic int size()
size
in interface Collection<E>
size
in interface List<E>
size
in class AbstractCollection<E>
public boolean isEmpty()
isEmpty
in interface Collection<E>
isEmpty
in interface List<E>
isEmpty
in class AbstractCollection<E>
public boolean contains(Object o)
contains
in interface Collection<E>
contains
in interface List<E>
contains
in class AbstractCollection<E>
o
- element whose presence in this list is to be tested
public int indexOf(Object o)
o
- element to search for
public int lastIndexOf(Object o)
lastIndexOf
in interface List<E>
lastIndexOf
in class AbstractList<E>
o
- element to search for
public Object clone()
Cloneable
public Object[] toArray()
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
in interface Collection<E>
toArray
in interface List<E>
toArray
in class AbstractCollection<E>
Arrays.asList(Object[])
public <T> T[] toArray(T[] 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 Collection<E>
toArray
in interface List<E>
toArray
in class AbstractCollection<E>
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.
ArrayStoreException
- if the runtime type of the specified array
is not a supertype of the runtime type of every element in
this list
NullPointerException
- if the specified array is nullpublic E get(int index)
index
- index of the element to return
IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index >= size())public E set(int index, E element)
index
- index of the element to replaceelement
- element to be stored at the specified position
IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index >= size())public boolean add(E e)
add
in interface Collection<E>
add
in interface List<E>
add
in class AbstractList<E>
e
- element to be appended to this list
Collection.add(E)
)public void add(int index, E element)
index
- index at which the specified element is to be insertedelement
- element to be inserted
IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index > size())public E remove(int index)
index
- the index of the element to be removed
IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index >= size())public boolean remove(Object o)
remove
in interface Collection<E>
remove
in interface List<E>
remove
in class AbstractCollection<E>
o
- element to be removed from this list, if present
public void clear()
clear
in interface Collection<E>
clear
in interface List<E>
clear
in class AbstractList<E>
public boolean addAll(Collection<? extends E> c)
addAll
in interface Collection<E>
addAll
in interface List<E>
addAll
in class AbstractCollection<E>
c
- collection containing elements to be added to this list
NullPointerException
- if the specified collection is nullAbstractCollection.add(Object)
public boolean addAll(int index, Collection<? extends E> c)
index
- index at which to insert the first element from the
specified collectionc
- collection containing elements to be added to this list
IndexOutOfBoundsException
- if the index is out of range
(index < 0 || index > size())
NullPointerException
- if the specified collection is nullprotected void removeRange(int fromIndex, int toIndex)
removeRange
in class AbstractList<E>
fromIndex
- index of first element to be removedtoIndex
- index after last element to be removed
IndexOutOfBoundsException
- if fromIndex or toIndex out of
range (fromIndex < 0 || fromIndex >= size() || toIndex
> size() || toIndex < fromIndex)
|
Java™ Platform Standard Ed. 6 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.