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
,
getFirst
, getLast
, removeLast
, iterator
,
listIterator
, and reversed
operations run in constant time.
The add
, and addLast
operations 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.
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
Modifier and Type | Class and Description |
---|---|
pack-priv class | ArrayList.
Index-based split-by-two, lazily initialized Spliterator |
private class | ArrayList.
An optimized version of AbstractList.Itr |
private class | ArrayList.
An optimized version of AbstractList.ListItr |
private static class |
Modifier and Type | Field and Description |
---|---|
private static final int | DEFAULT_CAPACITY
Default initial capacity. |
private static final Object[] | DEFAULTCAPACITY_EMPTY_ELEMENTDATA
Shared empty array instance used for default sized empty instances. |
pack-priv transient Object[] | elementData
The array buffer into which the elements of the ArrayList are stored. |
private static final Object[] | EMPTY_ELEMENTDATA
Shared empty array instance used for empty instances. |
private static final long | |
private int | size
The size of the ArrayList (the number of elements it contains). |
Access | Constructor and Description |
---|---|
public | ArrayList(int
the initial capacity of the list initialCapacity)Constructs an empty list with the specified initial capacity. |
public | |
public | ArrayList(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 |
---|---|
private void | |
public boolean | add(E
element to be appended to this list e)Overrides java. Implements java. Appends the specified element to the end of this list. |
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. Inserts the specified element at the specified position in this list. |
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. 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. |
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. Inserts all of the elements in the specified collection into this list, starting at the specified position. |
public void | addFirst(E
the element to be added element)Overrides default java. Adds an element as the first element of this collection (optional operation). |
public void | addLast(E
the element to be added. element)Overrides default java. Adds an element as the last element of this collection (optional operation). |
pack-priv boolean | |
private void | |
pack-priv void | |
public void | clear()
Overrides java. Implements java. Removes all of the elements from this list. |
public Object | Returns: a clone of thisArrayList instanceOverrides java. Returns a shallow copy of this |
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. Returns |
pack-priv static <E> E | |
pack-priv E | |
public void | ensureCapacity(int
the desired minimum capacity minCapacity)Increases the capacity of this |
public boolean | equals(Object
the object to be compared for equality with this list o)Overrides java. Implements java. Compares the specified object with this list for equality. |
private boolean | |
pack-priv boolean | |
private void | fastRemove(Object[] es, int i)
Private remove method that skips bounds checking and does not return the value removed. |
public void | forEach(Consumer<? super E>
The action to be performed for each element action)Overrides default java. Performs the given action for each element of the |
public E | Returns: the element at the specified position in this listindex of the element to return index)Implements abstract java. Implements java. Returns the element at the specified position in this list. |
public E | |
public E | |
private Object[] | grow(int
the desired minimum capacity minCapacity)Increases the capacity to ensure that it can hold at least the number of elements specified by the minimum capacity argument. |
private Object[] | |
public int | hashCode()
Overrides java. Implements java. Returns the hash code value for this list. |
pack-priv int | |
public int | indexOf(Object
element to search for 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. |
pack-priv int | |
private static boolean | |
public boolean | Returns: true if this list contains no elementsOverrides java. Implements java. Returns |
public Iterator | Returns: an iterator over the elements in this list in proper sequenceOverrides java. Implements java. Returns an iterator over the elements in this list in proper sequence. |
public int | lastIndexOf(Object
element to search for 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. |
pack-priv int | |
public ListIterator | listIterator(int
index of the first element to be returned from the
list iterator (by a call to index)next )Overrides java. Implements java. Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list. |
public ListIterator | listIterator()
Overrides java. Implements java. Returns a list iterator over the elements in this list (in proper sequence). |
private static long[] | |
private String | outOfBoundsMsg(int index)
Hides java. Constructs an IndexOutOfBoundsException detail message. |
private static String | outOfBoundsMsg(int fromIndex, int toIndex)
A version used in checking (fromIndex > toIndex) condition |
private void | rangeCheckForAdd(int index)
Hides java. A version of rangeCheck used by add and addAll. |
private void | readObject(ObjectInputStream
the stream s)Reconstitutes the |
public E | Returns: the element that was removed from the listthe index of the element to be removed index)Overrides java. Implements java. Removes the element at the specified position in this list. |
public boolean | Returns: true if this list contained the specified elementelement to be removed from this list, if present o)Overrides java. Implements java. Removes the first occurrence of the specified element from this list, if it is present. |
public boolean | Returns: true if this list changed as a result of the callcollection containing elements to be removed from this list c)Overrides java. Implements java. Removes from this list all of its elements that are contained in the specified collection. |
public E | removeFirst()
Overrides default java. Removes and returns the first element of this collection (optional operation). |
public boolean | removeIf(Predicate<? super E>
a predicate which returns filter)true for elements to be
removedOverrides default java. Removes all of the elements of this collection that satisfy the given predicate (optional operation). |
pack-priv boolean | |
public E | removeLast()
Overrides default java. Removes and returns the last element of this collection (optional operation). |
protected void | removeRange(int
index of first element to be removed fromIndex, int index after last element to be removed toIndex)Overrides java. Removes from this list all of the elements whose index is between
|
public void | replaceAll(UnaryOperator<E>
the operator to apply to each element operator)Overrides default java. Replaces each element of this list with the result of applying the operator to that element (optional operation). |
private void | |
public boolean | Returns: true if this list changed as a result of the callcollection containing elements to be retained in this list c)Overrides java. Implements java. Retains only the elements in this list that are contained in the specified collection. |
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. Replaces the element at the specified position in this list with the specified element. |
private static void | |
private void | shiftTailOverGap(Object[] es, int lo, int hi)
Erases the gap from lo to hi, by sliding down following elements. |
public int | Returns: the number of elements in this listImplements abstract java. Implements java. Returns the number of elements in this list. |
public void | sort(Comparator<? super E>
the c)Comparator used to compare list elements.
A null value indicates that the elements'
natural ordering should be usedOverrides default java. Sorts this list according to the order induced by the specified
|
public Spliterator | Returns: aSpliterator over the elements in this listOverrides default java. Creates a late-binding
and fail-fast |
public List | subList(int
low endpoint (inclusive) of the subList fromIndex, int high endpoint (exclusive) of the subList toIndex)Overrides java. Implements java. Returns a view of the portion of this list between the specified
|
public Object[] | Returns: an array containing all of the elements in this list in proper sequenceOverrides java. Implements java. Returns an array containing all of the elements in this list in proper sequence (from first to last element). |
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. 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. |
public void | |
private void | writeObject(ObjectOutputStream
the stream s)Saves the state of the |