public class java.util
ArrayList<E>


Show All Login
Java SE 6
  
Extends: AbstractCollection > AbstractList
Implements: List, RandomAccess, Cloneable, Serializable
Extended by: AttributeList, RoleList, RoleUnresolvedList
Details
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.
version1.56, 04/21/06
since1.2
See also java.util.Collection, java.util.List, java.util.LinkedList, java.util.Vector


Constructors
public ArrayList(int initialCapacity) Details
Constructs an empty list with the specified initial capacity.
initialCapacitythe initial capacity of the list
ThrowsIllegalArgumentException: if the specified initial capacity is negative
public ArrayList()
Constructs an empty list with an initial capacity of ten.
public ArrayList(Collection c) Details
Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
cthe collection whose elements are to be placed into this list
ThrowsNullPointerException: if the specified collection is null

Methods
public boolean add(Object e) Details
Appends the specified element to the end of this list.
eelement to be appended to this list
returntrue (as specified by Collection#add)
public void add(int index, Object element) Details
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).
indexindex at which the specified element is to be inserted
elementelement to be inserted
ThrowsIndexOutOfBoundsException: if the index is out of range (index < 0 || index > size())
public boolean addAll(Collection c) Details
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.)
ccollection containing elements to be added to this list
returntrue if this list changed as a result of the call
ThrowsNullPointerException: if the specified collection is null
public boolean addAll(int index, Collection c) Details
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.
indexindex at which to insert the first element from the specified collection
ccollection containing elements to be added to this list
returntrue if this list changed as a result of the call
ThrowsIndexOutOfBoundsException: if the index is out of range (index < 0 || index > size())
ThrowsNullPointerException: if the specified collection is null
public void clear()
Removes all of the elements from this list. The list will be empty after this call returns.
public Object clone() Details
Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)
returna clone of this ArrayList instance
public boolean contains(Object o) Details
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)).
oelement whose presence in this list is to be tested
returntrue if this list contains the specified element
public void ensureCapacity(int minCapacity) Details
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.
minCapacitythe desired minimum capacity
public Object get(int index) Details
Returns the element at the specified position in this list.
indexindex of the element to return
returnthe element at the specified position in this list
ThrowsIndexOutOfBoundsException: if the index is out of range (index < 0 || index >= size())
public 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. 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.
public 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. 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.
public Object remove(int index) Details
Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).
indexthe index of the element to be removed
returnthe element that was removed from the list
ThrowsIndexOutOfBoundsException: if the index is out of range (index < 0 || index >= size())
public boolean remove(Object o) Details
Removes the first occurrence of the specified element from this list, if it is present. 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). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).
oelement to be removed from this list, if present
returntrue if this list contained the specified element
protected void removeRange(int fromIndex, int toIndex) Details
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.)
fromIndexindex of first element to be removed
toIndexindex after last element to be removed
ThrowsIndexOutOfBoundsException: if fromIndex or toIndex out of range (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)
public Object set(int index, Object element) Details
Replaces the element at the specified position in this list with the specified element.
indexindex of the element to replace
elementelement to be stored at the specified position
returnthe element previously at the specified position
ThrowsIndexOutOfBoundsException: if the index is out of range (index < 0 || index >= size())
public int size() Details
Returns the number of elements in this list.
returnthe number of elements in this list
public Object[] toArray() Details
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.
returnan array containing all of the elements in this list in proper sequence

public Object[]<T> toArray(Object[] a) Details
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 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.)
athe 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.
returnan array containing the elements of the list
ThrowsArrayStoreException: if the runtime type of the specified array is not a supertype of the runtime type of every element in this list
ThrowsNullPointerException: if the specified array is null

public void trimToSize()
Trims the capacity of this ArrayList instance to be the list's current size. An application can use this operation to minimize the storage of an ArrayList instance.

Properties
public boolean isEmpty() Details
Returns true if this list contains no elements.
returntrue if this list contains no elements