Top Description Inners Fields Constructors Methods
java.util

public Class ArrayList<E>

extends AbstractList<E>
implements List<E>, RandomAccess, Cloneable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.lang.Cloneable, java.util.RandomAccess, java.util.List, java.util.SequencedCollection, java.util.Collection, java.lang.Iterable
Type Parameters
<E>
the type of elements in this list
Imports
java.util.function.Consumer, .Predicate, .UnaryOperator, jdk.internal.access.SharedSecrets, jdk.internal.util.ArraysSupport

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, 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.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.

Authors
Josh Bloch, Neal Gafter
Since
1.2
See Also
Collection, List, LinkedList, Vector

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
ArrayList.ArrayListSpliterator

Index-based split-by-two, lazily initialized Spliterator

private class
ArrayList.Itr

An optimized version of AbstractList.Itr

private class
ArrayList.ListItr

An optimized version of AbstractList.ListItr

private static class

Field Summary

Modifier and TypeField 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).

Inherited from java.util.AbstractList:
modCount

Constructor Summary

AccessConstructor and Description
public
ArrayList(int
the initial capacity of the list
initialCapacity
)

Constructs an empty list with the specified initial capacity.

public
ArrayList()

Constructs an empty list with an initial capacity of ten.

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.

Method Summary

Modifier and TypeMethod and Description
private void
add(E e, Object[] elementData, int s)

This helper method split out from add(E) to keep method bytecode size under 35 (the -XX:MaxInlineSize default value), which helps when add(E) is called in a C1-compiled loop.

public boolean

Returns:

true (as specified by Collection#add)
add
(E
element to be appended to this list
e
)

Overrides java.util.AbstractList.add.

Implements java.util.List.add, java.util.Collection.add.

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.util.AbstractList.add.

Implements java.util.List.add.

Inserts the specified element at the specified position in this list.

public boolean

Returns:

true if this list changed as a result of the call
addAll
(Collection<? extends E>
collection containing elements to be added to this list
c
)

Overrides java.util.AbstractCollection.addAll.

Implements java.util.List.addAll, java.util.Collection.addAll.

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 call
addAll
(int
index 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.util.AbstractList.addAll.

Implements java.util.List.addAll.

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.util.List.addFirst.

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.util.List.addLast.

Adds an element as the last element of this collection (optional operation).

pack-priv boolean
batchRemove(Collection<?> c, boolean complement, final int from, final int end)

private void
checkForComodification(final int expectedModCount)

pack-priv void
public void
clear()

Overrides java.util.AbstractList.clear.

Implements java.util.List.clear, java.util.Collection.clear.

Removes all of the elements from this list.

public Object

Returns:

a clone of this ArrayList instance
clone
()

Overrides java.lang.Object.clone.

Returns a shallow copy of this ArrayList instance.

public boolean

Returns:

true if this list contains the specified element
contains
(Object
element whose presence in this list is to be tested
o
)

Overrides java.util.AbstractCollection.contains.

Implements java.util.List.contains, java.util.Collection.contains.

Returns true if this list contains the specified element.

pack-priv static <E> E
elementAt(Object[] es, int index)

pack-priv E
elementData(int index)

public void
ensureCapacity(int
the desired minimum capacity
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 boolean
equals(Object
the object to be compared for equality with this list
o
)

Overrides java.util.AbstractList.equals.

Implements java.util.List.equals, java.util.Collection.equals.

Compares the specified object with this list for equality.

private boolean
pack-priv boolean
equalsRange(List<?> other, int from, int to)

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.lang.Iterable.forEach.

Performs the given action for each element of the Iterable until all elements have been processed or the action throws an exception.

public E

Returns:

the element at the specified position in this list
get
(int
index of the element to return
index
)

Implements abstract java.util.AbstractList.get.

Implements java.util.List.get.

Returns the element at the specified position in this list.

public E
getFirst()

Overrides default java.util.List.getFirst.

Gets the first element of this collection.

public E
getLast()

Overrides default java.util.List.getLast.

Gets the last element of this collection.

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[]
grow()

public int
hashCode()

Overrides java.util.AbstractList.hashCode.

Implements java.util.List.hashCode, java.util.Collection.hashCode.

Returns the hash code value for this list.

pack-priv int
hashCodeRange(int from, int to)

public int
indexOf(Object
element to search for
o
)

Overrides java.util.AbstractList.indexOf.

Implements java.util.List.indexOf.

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
indexOfRange(Object o, int start, int end)

private static boolean
isClear(long[] bits, int i)

public boolean

Returns:

true if this list contains no elements
isEmpty
()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.List.isEmpty, java.util.Collection.isEmpty.

Returns true if this list contains no elements.

public Iterator<E>

Returns:

an iterator over the elements in this list in proper sequence
iterator
()

Overrides java.util.AbstractList.iterator.

Implements java.util.List.iterator, java.util.Collection.iterator.

Returns an iterator over the elements in this list in proper sequence.

public int
lastIndexOf(Object
element to search for
o
)

Overrides java.util.AbstractList.lastIndexOf.

Implements java.util.List.lastIndexOf.

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
lastIndexOfRange(Object o, int start, int end)

public ListIterator<E>
listIterator(int
index of the first element to be returned from the list iterator (by a call to next)
index
)

Overrides java.util.AbstractList.listIterator.

Implements java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list.

public ListIterator<E>
listIterator()

Overrides java.util.AbstractList.listIterator.

Implements java.util.List.listIterator.

Returns a list iterator over the elements in this list (in proper sequence).

private static long[]
nBits(int n)

private String
outOfBoundsMsg(int index)

Hides java.util.AbstractList.outOfBoundsMsg.

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.util.AbstractList.rangeCheckForAdd.

A version of rangeCheck used by add and addAll.

private void
readObject(ObjectInputStream
the stream
s
)

Reconstitutes the ArrayList instance from a stream (that is, deserializes it).

public E

Returns:

the element that was removed from the list
remove
(int
the index of the element to be removed
index
)

Overrides java.util.AbstractList.remove.

Implements java.util.List.remove.

Removes the element at the specified position in this list.

public boolean

Returns:

true if this list contained the specified element
remove
(Object
element to be removed from this list, if present
o
)

Overrides java.util.AbstractCollection.remove.

Implements java.util.List.remove, java.util.Collection.remove.

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 call
removeAll
(Collection<?>
collection containing elements to be removed from this list
c
)

Overrides java.util.AbstractCollection.removeAll.

Implements java.util.List.removeAll, java.util.Collection.removeAll.

Removes from this list all of its elements that are contained in the specified collection.

public E
removeFirst()

Overrides default java.util.List.removeFirst.

Removes and returns the first element of this collection (optional operation).

public boolean
removeIf(Predicate<? super E>
a predicate which returns true for elements to be removed
filter
)

Overrides default java.util.Collection.removeIf.

Removes all of the elements of this collection that satisfy the given predicate (optional operation).

pack-priv boolean
removeIf(Predicate<? super E> filter, int i, final int end)

Removes all elements satisfying the given predicate, from index i (inclusive) to index end (exclusive).

public E
removeLast()

Overrides default java.util.List.removeLast.

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.util.AbstractList.removeRange.

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.

public void
replaceAll(UnaryOperator<E>
the operator to apply to each element
operator
)

Overrides default java.util.List.replaceAll.

Replaces each element of this list with the result of applying the operator to that element (optional operation).

private void
replaceAllRange(UnaryOperator<E> operator, int i, int end)

public boolean

Returns:

true if this list changed as a result of the call
retainAll
(Collection<?>
collection containing elements to be retained in this list
c
)

Overrides java.util.AbstractCollection.retainAll.

Implements java.util.List.retainAll, java.util.Collection.retainAll.

Retains only the elements in this list that are contained in the specified collection.

public E

Returns:

the element previously at the specified position
set
(int
index of the element to replace
index
,
E
element to be stored at the specified position
element
)

Overrides java.util.AbstractList.set.

Implements java.util.List.set.

Replaces the element at the specified position in this list with the specified element.

private static void
setBit(long[] bits, int i)

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 list
size
()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.List.size, java.util.Collection.size.

Returns the number of elements in this list.

public void
sort(Comparator<? super E>
the Comparator used to compare list elements. A null value indicates that the elements' natural ordering should be used
c
)

Overrides default java.util.List.sort.

Sorts this list according to the order induced by the specified Comparator (optional operation).

public Spliterator<E>

Returns:

a Spliterator over the elements in this list
spliterator
()

Overrides default java.util.List.spliterator, java.util.Collection.spliterator.

Creates a late-binding and fail-fast Spliterator over the elements in this list.

public List<E>
subList(int
low endpoint (inclusive) of the subList
fromIndex
,
int
high endpoint (exclusive) of the subList
toIndex
)

Overrides java.util.AbstractList.subList.

Implements java.util.List.subList.

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.

public Object[]

Returns:

an array containing all of the elements in this list in proper sequence
toArray
()

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

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 list
toArray
(T[]
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.
a
)

Overrides java.util.AbstractCollection.toArray.

Implements java.util.List.toArray, java.util.Collection.toArray.

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
trimToSize()

Trims the capacity of this ArrayList instance to be the list's current size.

private void
writeObject(ObjectOutputStream
the stream
s
)

Saves the state of the ArrayList instance to a stream (that is, serializes it).

Inherited from java.util.AbstractList:
subListRangeCheck