Save This Page
Home » openjdk-7 » java » util » [javadoc | source]
java.util
public class: ArrayList [javadoc | source]
java.lang.Object
   java.util.AbstractCollection<E>
      java.util.AbstractList<E>
         java.util.ArrayList

All Implemented Interfaces:
    Cloneable, List, Serializable, RandomAccess, Collection

Direct Known Subclasses:
    RoleList, AttributeList, RoleUnresolvedList

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 {@code 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.

Fields inherited from java.util.AbstractList:
modCount
Constructor:
 public ArrayList() 
 public ArrayList(int initialCapacity) 
 public 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.
    Parameters:
    c - the collection whose elements are to be placed into this list
    Throws:
    NullPointerException - if the specified collection is null
Method from java.util.ArrayList Summary:
add,   add,   addAll,   addAll,   clear,   clone,   contains,   elementData,   ensureCapacity,   get,   indexOf,   isEmpty,   iterator,   lastIndexOf,   listIterator,   listIterator,   remove,   remove,   removeAll,   removeRange,   retainAll,   set,   size,   subList,   subListRangeCheck,   toArray,   toArray,   trimToSize
Methods from java.util.AbstractList:
add,   add,   addAll,   clear,   equals,   get,   hashCode,   indexOf,   iterator,   lastIndexOf,   listIterator,   listIterator,   remove,   removeRange,   set,   subList
Methods from java.util.AbstractCollection:
add,   addAll,   clear,   contains,   containsAll,   isEmpty,   iterator,   remove,   removeAll,   retainAll,   size,   toArray,   toArray,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.ArrayList Detail:
 public boolean add(E e) 
    Appends the specified element to the end of this list.
 public  void add(int index,
    E 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).
 public 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. 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.)
 public 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. 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.
 public  void clear() 
    Removes all of the elements from this list. The list will be empty after this call returns.
 public Object clone() 
    Returns a shallow copy of this ArrayList instance. (The elements themselves are not copied.)
 public boolean contains(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)).
 E elementData(int index) 
 public  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.
 public E get(int index) 
    Returns the element at the specified position in this list.
 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 boolean isEmpty() 
    Returns true if this list contains no elements.
 public Iterator<E> iterator() 
    Returns an iterator over the elements in this list in proper sequence.

    The returned iterator is fail-fast.

 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 ListIterator<E> listIterator() 
    Returns a list iterator over the elements in this list (in proper sequence).

    The returned list iterator is fail-fast.

 public ListIterator<E> listIterator(int index) 
    Returns a list iterator over 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 next . An initial call to previous would return the element with the specified index minus one.

    The returned list iterator is fail-fast.

 public E 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).
 public boolean remove(Object o) 
    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).
 public boolean removeAll(Collection<?> c) 
    Removes from this list all of its elements that are contained in the specified collection.
 protected  void removeRange(int fromIndex,
    int toIndex) 
    Removes from this list all of the elements whose index is between {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the list by {@code (toIndex - fromIndex)} elements. (If {@code toIndex==fromIndex}, this operation has no effect.)
 public boolean retainAll(Collection<?> c) 
    Retains only the elements in this list that are contained in the specified collection. In other words, removes from this list all of its elements that are not contained in the specified collection.
 public E set(int index,
    E element) 
    Replaces the element at the specified position in this list with the specified element.
 public int size() 
    Returns the number of elements in this list.
 public List<E> subList(int fromIndex,
    int toIndex) 
    Returns a view of the portion of this list between the specified {@code fromIndex}, inclusive, and {@code toIndex}, exclusive. (If {@code fromIndex} and {@code toIndex} are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations.

    This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

         list.subList(from, to).clear();
    
    Similar idioms may be constructed for #indexOf(Object) and #lastIndexOf(Object) , and all of the algorithms in the Collections class can be applied to a subList.

    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 this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

 static  void subListRangeCheck(int fromIndex,
    int toIndex,
    int size) 
 public Object[] toArray() 
    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.

 public T[] 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. 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.)

 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.