| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public class ArrayList extends AbstractList implements List, RandomAccess, Cloneable, Serializable
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 {@link Collections#synchronizedList 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 {@link 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.
Field Summary |
---|
Fields inherited from class java.util.AbstractList |
---|
modCount |
Constructor Summary | |
---|---|
Constructs an empty list with an initial capacity of ten. |
|
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 |
Appends the specified element to the end of this list. |
void |
Inserts the specified element at the specified position in this list. |
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. |
boolean |
addAll(int index, Collection 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 |
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. |
Object |
get(int index) Returns the element at the specified position in this list. |
int |
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 |
Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. |
Object |
remove(int index) Removes the element at the specified position in this list. |
boolean |
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. |
Object |
Replaces the element at the specified position in this list with the specified element. |
int |
size() Returns the number of elements in this list. |
void |
sort() Sorts this list. |
Object[] |
toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element). |
Object[] |
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 |
Trims the capacity of this ArrayList instance to be the list's current size. |
Methods inherited from class java.util.AbstractList |
---|
add, add, addAll, clear, equals, get, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList |
Methods inherited from class java.util.AbstractCollection |
---|
add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ArrayList()
public ArrayList(Collection c)
c
- the collection whose elements are to be placed into this listpublic ArrayList(int initialCapacity)
initialCapacity
- the initial capacity of the listMethod Detail |
---|
public boolean add(Object e)
add
in class AbstractList
e
- element to be appended to this listpublic void add(int index, Object element)
add
in class AbstractList
index
- index at which the specified element is to be insertedelement
- element to be insertedpublic boolean addAll(Collection c)
addAll
in class AbstractCollection
c
- collection containing elements to be added to this listpublic boolean addAll(int index, Collection c)
addAll
in class AbstractList
index
- index at which to insert the first element from the
specified collectionc
- collection containing elements to be added to this listpublic void clear()
clear
in class AbstractList
public Object clone()
clone
in class Object
public boolean contains(Object o)
contains
in class AbstractCollection
o
- element whose presence in this list is to be testedpublic void ensureCapacity(int minCapacity)
minCapacity
- the desired minimum capacitypublic Object get(int index)
get
in class AbstractList
index
- index of the element to returnpublic int indexOf(Object o)
indexOf
in class AbstractList
o
public boolean isEmpty()
isEmpty
in class AbstractCollection
public int lastIndexOf(Object o)
lastIndexOf
in class AbstractList
o
public Object remove(int index)
remove
in class AbstractList
index
- the index of the element to be removedpublic boolean remove(Object o)
remove
in class AbstractCollection
o
- element to be removed from this list, if presentprotected void removeRange(int fromIndex, int toIndex)
removeRange
in class AbstractList
fromIndex
- index of first element to be removedtoIndex
- index after last element to be removedpublic Object set(int index, Object element)
set
in class AbstractList
index
- index of the element to replaceelement
- element to be stored at the specified positionpublic int size()
size
in class AbstractCollection
public void sort()
java.util.Collections.sort(List)
.
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 class AbstractCollection
public Object[] toArray(Object[] 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 class AbstractCollection
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.public void trimToSize()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |