Класс ArrayList<E>

Реализация массива с изменяемым размером интерфейса List. Реализует все необязательные операции списка и допускает все элементы, включая null. В дополнение к реализации интерфейса List, этот класс предоставляет методы для изменения размера массива, используемого внутри для хранения списка. (Этот класс примерно эквивалентен Vector, за исключением того, что он не синхронизирован.)

Операции size, isEmpty, get, set, iterator, и listIterator выполняются за константное время. Операция add выполняется за амортизированное константное время, то есть добавление n элементов требует времени O(n). Все остальные операции выполняются за линейное время (грубо говоря). Постоянный множитель меньше, чем для реализации LinkedList.

Каждый экземпляр ArrayList имеет емкость. Емкость — это размер массива, используемого для хранения элементов в списке. Она всегда не меньше размера списка. Когда элементы добавляются в ArrayList, его емкость автоматически увеличивается. Подробности политики роста не уточняются, за исключением того, что добавление элемента имеет амортизированную константную стоимость.

Приложение может увеличить емкость экземпляра ArrayList перед добавлением большого количества элементов, используя операцию ensureCapacity. Это может уменьшить количество последовательных перераспределений.

Обратите внимание, что эта реализация не синхронизирована. Если несколько потоков одновременно обращаются к экземпляру ArrayList и по крайней мере один из потоков структурно изменяет список, он должен быть синхронизирован внешне. (Структурное изменение — это любая операция, добавляющая или удаляющая один или несколько элементов, или явно изменяющая размер массива-хранилища; простое изменение значения элемента не является структурным изменением.) Это обычно достигается путем синхронизации на некотором объекте, естественным образом инкапсулирующем список. Если такого объекта нет, список следует «обернуть» с помощью метода Collections.synchronizedList. Это лучше всего делать во время создания, чтобы предотвратить случайный несинхронизированный доступ к списку:

List list = Collections.synchronizedList(new ArrayList(...));

Итераторы, возвращаемые методами iterator и listIterator этого класса, являются быстропроверяемыми: если список структурно изменяется в любое время после создания итератора, любым способом, кроме методов итератора remove или add, итератор выбросит исключение ConcurrentModificationException. Таким образом, при одновременном изменении итератор быстро и четко завершается, а не рискует произвольным непредсказуемым поведением в неопределенное время в будущем.

Обратите внимание, что поведение быстропроверяемого итератора не гарантируется, так как в общем случае невозможно дать какие-либо гарантии при наличии несинхронизированных одновременных изменений. Быстропроверяемые итераторы выбрасывают ConcurrentModificationException на основе наилучших усилий. Поэтому неправильно писать программу, которая полагалась бы на это исключение для правильности: поведение быстропроверяемых итераторов следует использовать только для обнаружения ошибок.

Этот класс является членом Java Collections Framework.

Конструкторы

ArrayList

public ArrayList(int initialCapacity)

Создаёт пустой список с указанной начальной ёмкостью.

Параметры:

initialCapacity - начальная ёмкость списка

Исключения:

IllegalArgumentException - если указанная начальная ёмкость отрицательна

ArrayList

public ArrayList()

Создаёт пустой список с начальной ёмкостью десять.

ArrayList

public ArrayList(Collection<? extends E> c)

Создаёт список, содержащий элементы указанного набора, в порядке, в котором они возвращаются итератором набора.

Параметры:

c - набор, элементы которого должны быть помещены в этот список

Исключения:

NullPointerException - если указанный набор равен null

Методы

trimToSize

public void trimToSize()

Уменьшает ёмкость этого ArrayList экземпляра до текущего размера списка. Приложение может использовать эту операцию для минимизации хранилища ArrayList экземпляра.

ensureCapacity

public void ensureCapacity(int minCapacity)

Увеличивает ёмкость этого ArrayList экземпляра, если необходимо, чтобы гарантировать возможность хранения, по крайней мере, количества элементов, указанного в аргументе минимальной ёмкости.

Параметры:

minCapacity - желаемая минимальная ёмкость

size

public int size()

Возвращает количество элементов в этом списке.

Определено в:

size в интерфейсе Collection<E>

Определено в:

size в интерфейсе List<E>

Определено в:

size в классе AbstractCollection<E>

Возвращает:

количество элементов в этом списке

isEmpty

public boolean isEmpty()

Возвращает true, если этот список не содержит элементов.

Определено в:

isEmpty в интерфейсе Collection<E>

Определено в:

isEmpty в интерфейсе List<E>

Переопределено в:

isEmpty в классе AbstractCollection<E>

Возвращает:

true если этот список не содержит элементов

contains

public boolean contains(Object o)

Возвращает true, если этот список содержит указанный элемент. Более формально, возвращает true, если и только если этот список содержит по крайней мере один элемент e, такой что (o==null ? e==null : o.equals(e)).

Определено в:

contains в интерфейсе Collection<E>

Определено в:

contains в интерфейсе List<E>

Переопределено в:

contains в классе AbstractCollection<E>

Параметры:

o - элемент, присутствие которого в этом списке необходимо проверить

Возвращает:

true если этот список содержит указанный элемент

indexOf

public int indexOf(Object o)

Возвращает индекс первого вхождения указанного элемента в этот список или -1, если этот список не содержит элемент. Более формально, возвращает наименьший индекс i, такой что (o==null ? get(i)==null : o.equals(get(i))), или -1, если такого индекса нет.

Определено в:

indexOf в интерфейсе List<E>

Переопределено в:

indexOf в классе AbstractList<E>

Параметры:

o - элемент для поиска

Возвращает:

индекс первого вхождения указанного элемента в этот список или -1, если этот список не содержит элемент

lastIndexOf

public int lastIndexOf(Object o)

Возвращает индекс последнего вхождения указанного элемента в этом списке или -1, если этот список не содержит элемент. Более формально, возвращает наибольший индекс i, такой что (o==null ? get(i)==null : o.equals(get(i))), или -1, если такого индекса нет.

Определено в:

lastIndexOf в интерфейсе List<E>

Переопределено в:

lastIndexOf в классе AbstractList<E>

Параметры:

o - элемент для поиска

Возвращает:

индекс последнего вхождения указанного элемента в этот список или -1, если этот список не содержит элемент

clone

public Object clone()

Возвращает неглубокую копию этого ArrayList экземпляра. (Сами элементы не копируются.)

Переопределено в:

clone в классе Object

Возвращает:

клонированный экземпляр этого ArrayList экземпляра

См. также:

Cloneable

toArray

public Object[] toArray()

Определено в:

toArray в интерфейсе Collection<E>

Определено в:

toArray в интерфейсе List<E>

Переопределено в:

toArray в классе AbstractCollection<E>

Возвращает:

массив, содержащий все элементы этого списка в правильной последовательности

См. также:

Arrays.asList(Object[])

toArray

public <T> T[] toArray(T[] a)

Определено в:

toArray в интерфейсе Collection<E>

Определено в:

toArray в интерфейсе List<E>

Переопределено в:

toArray в классе AbstractCollection<E>

Параметры типа:

T - тип выполнения массива, который должен содержать коллекцию

Параметры:

a - массив, в который должны быть помещены элементы списка, если он достаточно большой; в противном случае для этой цели выделяется новый массив того же типа выполнения.

Возвращает:

массив, содержащий элементы списка

Исключения:

ArrayStoreException - если тип выполнения указанного массива не является надтипом типа выполнения каждого элемента в этом списке

NullPointerException - если указанный массив равен null

get

public E get(int index)

Возвращает элемент по указанному индексу в этом списке.

Определено в:

get в интерфейсе List<E>

Определено в:

get в классе AbstractList<E>

Параметры:

index - индекс возвращаемого элемента

Возвращает:

элемент по указанному индексу в этом списке

Исключения:

IndexOutOfBoundsException - если индекс находится вне диапазона (index < 0 || index >= size())

set

public E set(int index,
             E element)

Заменяет элемент по указанному индексу в этом списке указанным элементом.

Определено в:

set в интерфейсе List<E>

Переопределено в:

set в классе AbstractList<E>

Параметры:

index - индекс заменяемого элемента

element - элемент, который необходимо сохранить по указанному индексу

Возвращает:

элемент, который ранее находился по указанному индексу

Исключения:

IndexOutOfBoundsException - если индекс находится вне диапазона (index < 0 || index >= size())

add

public boolean add(E e)

Добавляет указанный элемент в конец этого списка.

Определено в:

add в интерфейсе Collection<E>

Определено в:

add в интерфейсе List<E>

Переопределено в:

add в классе AbstractList<E>

Параметры:

e - элемент, который необходимо добавить в этот список

Возвращает:

true (как указано в Collection.add(E))

add

public void add(int index,
                E element)

Вставляет указанный элемент в указанную позицию в этом списке. Сдвигает элемент, который в данный момент находится в этой позиции (если такой есть), и все последующие элементы вправо (увеличивает их индексы на 1).

Определено в:

add в интерфейсе List<E>

Переопределено в:

add в классе AbstractList<E>

Параметры:

index - индекс, в котором необходимо вставить указанный элемент

element - вставляемый элемент

Исключения:

IndexOutOfBoundsException - если индекс находится вне диапазона (index < 0 || index > size())

remove

public E remove(int index)

Удаляет элемент по указанному индексу в этом списке. Сдвигает все последующие элементы влево (уменьшает их индексы на 1).

Определено в:

remove в интерфейсе List<E>

Переопределено в:

remove в классе AbstractList<E>

Параметры:

index - индекс удаляемого элемента

Возвращает:

удаленный из списка элемент

Исключения:

IndexOutOfBoundsException - если индекс находится вне диапазона (index < 0 || index >= size())

remove

public boolean remove(Object o)

Удаляет первое вхождение указанного элемента из этого списка, если он присутствует. Если список не содержит элемент, он не изменяется. Более формально, удаляет элемент с наименьшим индексом i таким образом, что (o==null ? get(i)==null : o.equals(get(i))) (если такой элемент существует). Возвращает true если этот список содержал указанный элемент (или, что эквивалентно, если этот список изменился в результате вызова).

Указано в:

remove в интерфейсе Collection<E>

Указано в:

remove в интерфейсе List<E>

Переопределяет:

remove в классе AbstractCollection<E>

Параметры:

o - элемент, который нужно удалить из этого списка, если он присутствует

Возвращает:

true если этот список содержал указанный элемент

clear

public void clear()

Удаляет все элементы из этого списка. Список будет пустым после возврата этого вызова.

Указано в:

clear в интерфейсе Collection<E>

Указано в:

clear в интерфейсе List<E>

Переопределяет:

clear в классе AbstractList<E>

addAll

public boolean addAll(Collection<? extends E> c)

Добавляет все элементы из указанного набора в конец этого списка в порядке, в котором они возвращаются итератором указанного набора. Поведение этой операции не определено, если указанный набор изменяется во время выполнения операции. (Это подразумевает, что поведение этого вызова не определено, если указанный набор является этим списком, а этот список не пуст.)

Указано в:

addAll в интерфейсе Collection<E>

Указано в:

addAll в интерфейсе List<E>

Переопределяет:

addAll в классе AbstractCollection<E>

Параметры:

c - набор, содержащий элементы, которые нужно добавить в этот список

Возвращает:

true если этот список изменился в результате вызова

Исключения:

NullPointerException - если указанный набор равен null

См. также:

AbstractCollection.add(Object)

addAll

public boolean addAll(int index,
                      Collection<? extends E> c)

Вставляет все элементы из указанного набора в этот список, начиная с указанной позиции. Смещает элемент, который в данный момент находится на этой позиции (если таковой имеется), и все последующие элементы вправо (увеличивает их индексы). Новые элементы появятся в списке в том порядке, в котором они возвращаются итератором указанного набора.

Указано в:

addAll в интерфейсе List<E>

Переопределяет:

addAll в классе AbstractList<E>

Параметры:

index - индекс, с которого нужно вставить первый элемент из указанного набора

c - набор, содержащий элементы, которые нужно добавить в этот список

Возвращает:

true если этот список изменился в результате вызова

Исключения:

IndexOutOfBoundsException - если индекс находится вне допустимого диапазона (index < 0 || index > size())

NullPointerException - если указанный набор равен null

removeRange

protected void removeRange(int fromIndex,
                           int toIndex)

Удаляет из этого списка все элементы, индекс которых находится между fromIndex, включительно, и toIndex, исключая. Смещает любые последующие элементы влево (уменьшает их индекс). Этот вызов укорачивает список на (toIndex - fromIndex) элементов. (Если toIndex==fromIndex, эта операция не имеет эффекта.)

Переопределяет:

removeRange в классе AbstractList<E>

Параметры:

fromIndex - индекс первого удаляемого элемента

toIndex - индекс после последнего удаляемого элемента

Исключения:

IndexOutOfBoundsException - если fromIndex или toIndex находятся вне допустимого диапазона (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)

removeAll

public boolean removeAll(Collection<?> c)

Удаляет из этого списка все его элементы, содержащиеся в указанном наборе.

Указано в:

removeAll в интерфейсе Collection<E>

Указано в:

removeAll в интерфейсе List<E>

Переопределяет:

removeAll в классе AbstractCollection<E>

Параметры:

c - набор, содержащий элементы, которые нужно удалить из этого списка

Возвращает:

true если этот список изменился в результате вызова

Исключения:

ClassCastException - если класс элемента этого списка несовместим с указанным набором (необязательно)

NullPointerException - если этот список содержит null-элемент, а указанный набор не допускает null-элементы (необязательно), или если указанный набор равен null

См. также:

Collection.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

Сохраняет только элементы в этом списке, которые содержатся в указанном наборе. Другими словами, удаляет из этого списка все его элементы, которые не содержатся в указанном наборе.

Указано в:

retainAll в интерфейсе Collection<E>

Указано в:

retainAll в интерфейсе List<E>

Переопределяет:

retainAll в классе AbstractCollection<E>

Параметры:

c - набор, содержащий элементы, которые нужно сохранить в этом списке

Возвращает:

true если этот список изменился в результате вызова

Исключения:

ClassCastException - если класс элемента этого списка несовместим с указанным набором (необязательно)

NullPointerException - если этот список содержит null-элемент, а указанный набор не допускает null-элементы (необязательно), или если указанный набор равен null

См. также:

Collection.contains(Object)

listIterator

public ListIterator<E> listIterator(int index)

Указано в:

listIterator в интерфейсе List<E>

Переопределяет:

listIterator в классе AbstractList<E>

Параметры:

index - индекс первого элемента, который будет возвращен итератором списка (вызовом next)

Возвращает:

итератор списка по элементам в этом списке (в правильной последовательности), начиная с указанной позиции в списке

Исключения:

IndexOutOfBoundsException - если индекс находится вне допустимого диапазона (index < 0 || index > size())

listIterator

public ListIterator<E> listIterator()

Указано в:

listIterator в интерфейсе List<E>

Переопределяет:

listIterator в классе AbstractList<E>

Возвращает:

итератор списка по элементам в этом списке (в правильной последовательности)

См. также:

listIterator(int)

iterator

public Iterator<E> iterator()

Указано в:

iterator в интерфейсе Iterable<E>

Указано в:

iterator в интерфейсе Collection<E>

Указано в:

iterator в интерфейсе List<E>

Переопределяет:

iterator в классе AbstractList<E>

Возвращает:

итератор по элементам в этом списке в правильной последовательности

subList

public List<E> subList(int fromIndex,
                       int toIndex)

list.subList(from, to).clear();

Определено в:

subList в интерфейсе List<E>

Переопределено в:

subList в классе AbstractList<E>

Параметры:

fromIndex - нижняя граница (включительно) подсписка

toIndex - верхняя граница (исключительно) подсписка

Возвращает:

вид указанного диапазона в этом списке

Исключение:

IndexOutOfBoundsException - если индекс граничного значения выходит за пределы диапазона (fromIndex < 0 || toIndex > size)

IllegalArgumentException - если индексы граничных значений расположены не по порядку (fromIndex > toIndex)

forEach

public void forEach(Consumer<? super E> action)

Описание скопировано из интерфейса: Iterable

Выполняет данное действие для каждого элемента Iterable до тех пор, пока все элементы не будут обработаны или действие не выбросит исключение. Если не указано иное реализующим классом, действия выполняются в порядке итерации (если порядок итерации задан). Исключение, брошенное действием, передается вызывающей стороне.

Определено в:

forEach в интерфейсе Iterable<E>

Параметры:

action - действие, которое должно выполняться для каждого элемента

spliterator

public Spliterator<E> spliterator()

Определено в:

spliterator в интерфейсе Iterable<E>

Определено в:

spliterator в интерфейсе Collection<E>

Определено в:

spliterator в интерфейсе List<E>

Возвращает:

Spliterator по элементам в этом списке

С:

1.8

removeIf

public boolean removeIf(Predicate<? super E> filter)

Описание скопировано из интерфейса: Collection

Удаляет все элементы этого набора, удовлетворяющие заданному предикату. Ошибки или исключения во время выполнения, сгенерированные во время итерации или предикатом, передаются вызывающей стороне.

Определено в:

removeIf в интерфейсе Collection<E>

Параметры:

filter - предикат, возвращающий true для элементов, подлежащих удалению

Возвращает:

true если какие-либо элементы были удалены

replaceAll

public void replaceAll(UnaryOperator<E> operator)

Описание скопировано из интерфейса: List

Заменяет каждый элемент этого списка результатом применения оператора к этому элементу. Ошибки или исключения во время выполнения, сгенерированные оператором, передаются вызывающей стороне.

Определено в:

replaceAll в интерфейсе List<E>

Параметры:

operator - оператор, применяемый к каждому элементу

sort

public void sort(Comparator<? super E> c)

Описание скопировано из интерфейса: List

Определено в:

sort в интерфейсе List<E>

Параметры:

c - Comparator для сравнения элементов списка. Значение null указывает, что должен использоваться естественный порядок элементов