Класс CopyOnWriteArrayList<E>
- Параметры типа:
E— тип элементов, хранящихся в этом списке
- Все реализуемые интерфейсы:
Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess, SequencedCollection<E>
public class CopyOnWriteArrayList<E> extends Object implements List<E>, RandomAccess, Cloneable, Serializable
ArrayList, в котором все изменяющие операции (add, set и т. д.) выполняются путем создания новой копии базового массива. Обычно это слишком затратно, но может быть более эффективно, чем альтернативы, когда операции обхода значительно преобладают над изменениями. Этот класс полезен, если синхронизировать обходы невозможно или нежелательно, но при этом необходимо исключить взаимное влияние параллельно работающих потоков. Метод итератора в стиле «снимка» использует ссылку на состояние массива в момент создания итератора. Этот массив не изменяется в течение всего времени существования итератора, поэтому взаимное влияние невозможно, а гарантируется, что итератор не выбросит ConcurrentModificationException. Итератор не отражает добавления, удаления или изменения списка, произошедшие после его создания. Операции изменения элементов непосредственно через итераторы (remove, set и add) не поддерживаются. Эти методы выбрасывают UnsupportedOperationException.
Допускаются любые элементы, включая null.
Эффекты согласованности памяти: как и в других параллельных коллекциях, действия в потоке, предшествующие помещению объекта в CopyOnWriteArrayList, предшествуют по отношению happens-before действиям, следующим за доступом к этому элементу или его удалением из CopyOnWriteArrayList в другом потоке.
Этот класс является частью Java Collections Framework.
- Начиная с версии:
- 1.5
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
CopyOnWriteArrayList() |
Создает пустой список. |
CopyOnWriteArrayList |
Создает список, содержащий копию заданного массива. |
CopyOnWriteArrayList |
Создает список, содержащий элементы указанной коллекции в том порядке, в котором они возвращаются итератором коллекции. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
add |
Вставляет указанный элемент в указанную позицию этого списка. |
boolean |
add |
Добавляет указанный элемент в конец этого списка. |
boolean |
addAll |
Вставляет все элементы указанной коллекции в этот список, начиная с указанной позиции. |
boolean |
addAll |
Добавляет все элементы указанной коллекции в конец этого списка в том порядке, в котором они возвращаются итератором указанной коллекции. |
int |
addAllAbsent |
Добавляет в конец этого списка все элементы указанной коллекции, которые еще не содержатся в этом списке, в том порядке, в котором они возвращаются итератором указанной коллекции. |
void |
addFirst |
Добавляет элемент в начало этой коллекции (необязательная операция). |
boolean |
addIfAbsent |
Добавляет элемент, если он еще не присутствует. |
void |
addLast |
Добавляет элемент в конец этой коллекции (необязательная операция). |
void |
clear() |
Удаляет все элементы из этого списка. |
Object |
clone() |
Возвращает поверхностную копию этого списка. |
boolean |
contains |
Возвращает true, если этот список содержит указанный элемент. |
boolean |
containsAll |
Возвращает true, если этот список содержит все элементы указанной коллекции. |
boolean |
equals |
Сравнивает указанный объект с этим списком на равенство. |
void |
forEach |
Выполняет указанное действие для каждого элемента Iterable, пока не будут обработаны все элементы или действие не выбросит исключение. |
E |
get |
Возвращает элемент, находящийся в указанной позиции этого списка. |
E |
getFirst() |
Возвращает первый элемент этой коллекции. |
E |
getLast() |
Возвращает последний элемент этой коллекции. |
int |
hashCode() |
Возвращает значение хеш-кода этого списка. |
int |
indexOf |
Возвращает индекс первого вхождения указанного элемента в этом списке при поиске вперед от index или возвращает -1, если элемент не найден. |
int |
indexOf |
Возвращает индекс первого вхождения указанного элемента в этом списке или -1, если список не содержит этот элемент. |
boolean |
isEmpty() |
Возвращает true, если список не содержит элементов. |
Iterator |
iterator() |
Возвращает итератор по элементам этого списка в надлежащем порядке. |
int |
lastIndexOf |
Возвращает индекс последнего вхождения указанного элемента в этом списке при поиске назад от index или возвращает -1, если элемент не найден. |
int |
lastIndexOf |
Возвращает индекс последнего вхождения указанного элемента в этом списке или -1, если список не содержит этот элемент. |
ListIterator |
listIterator() |
Возвращает итератор списка по элементам этого списка (в надлежащем порядке). |
ListIterator |
listIterator |
Возвращает итератор списка по элементам этого списка (в надлежащем порядке), начиная с указанной позиции в списке. |
E |
remove |
Удаляет элемент, находящийся в указанной позиции этого списка. |
boolean |
remove |
Удаляет первое вхождение указанного элемента из этого списка, если оно присутствует. |
boolean |
removeAll |
Удаляет из этого списка все элементы, содержащиеся в указанной коллекции. |
E |
removeFirst() |
Удаляет и возвращает первый элемент этой коллекции (необязательная операция). |
boolean |
removeIf |
Удаляет все элементы этой коллекции, удовлетворяющие заданному предикату (необязательная операция). |
E |
removeLast() |
Удаляет и возвращает последний элемент этой коллекции (необязательная операция). |
boolean |
retainAll |
Оставляет в этом списке только элементы, содержащиеся в указанной коллекции. |
List |
reversed() |
Возвращает представление этой коллекции в обратном порядке. |
E |
set |
Заменяет элемент, находящийся в указанной позиции этого списка, указанным элементом. |
int |
size() |
Возвращает количество элементов в этом списке. |
Spliterator |
spliterator() |
Возвращает Spliterator для элементов этого списка. |
List |
subList |
Возвращает представление части этого списка от fromIndex включительно до toIndex исключительно. |
Object[] |
toArray() |
Возвращает массив, содержащий все элементы этого списка в надлежащем порядке (от первого элемента до последнего). |
<T> T[] |
toArray |
Возвращает массив, содержащий все элементы этого списка в надлежащем порядке (от первого элемента до последнего); тип возвращаемого массива во время выполнения соответствует типу указанного массива. |
String |
toString() |
Возвращает строковое представление этого списка. |
Методы, объявленные в интерфейсе Collection
parallelStream, stream, toArray
Методы, объявленные в интерфейсе List
replaceAll, sort
Подробное описание конструкторов
CopyOnWriteArrayList
public CopyOnWriteArrayList()
CopyOnWriteArrayList
public CopyOnWriteArrayList(Collection<? extends E> c)
- Параметры:
-
c— коллекция элементов, изначально помещаемых в список - Исключения:
-
NullPointerException— если указанная коллекция равна null
CopyOnWriteArrayList
public CopyOnWriteArrayList(E[] toCopyIn)
- Параметры:
-
toCopyIn— массив (копия этого массива используется в качестве внутреннего массива) - Исключения:
-
NullPointerException— если указанный массив равен null
Подробное описание методов
size
isEmpty
contains
public boolean contains(Object o)
true, если этот список содержит указанный элемент. Формально метод возвращает true тогда и только тогда, когда этот список содержит хотя бы один элемент e такой, что Objects.equals(o, e).indexOf
public int indexOf(Object o)
i такой, что Objects.equals(o, get(i)), или -1, если такого индекса нет.indexOf
public int indexOf(E e, int index)
index, или возвращает -1, если элемент не найден. Формально возвращает наименьший индекс i такой, что i >= index && Objects.equals(get(i), e), или -1, если такого индекса нет.- Параметры:
-
e— элемент для поиска -
index— индекс, с которого начинается поиск - Возвращает:
- индекс первого вхождения элемента в этом списке в позиции
indexили позднее;-1, если элемент не найден. - Исключения:
-
IndexOutOfBoundsException— если указанный индекс отрицательный
lastIndexOf
public int lastIndexOf(Object o)
i такой, что Objects.equals(o, get(i)), или -1, если такого индекса нет.- Определено в:
-
lastIndexOfв интерфейсеList<E> - Параметры:
-
o— элемент для поиска - Возвращает:
- индекс последнего вхождения указанного элемента в этот список или -1, если список не содержит этот элемент
lastIndexOf
public int lastIndexOf(E e, int index)
index, или возвращает -1, если элемент не найден. Формально возвращает наибольший индекс i такой, что i <= index && Objects.equals(get(i), e), или -1, если такого индекса нет.- Параметры:
-
e— элемент для поиска -
index— индекс, с которого начинается поиск в обратном направлении - Возвращает:
- индекс последнего вхождения элемента в позиции, меньшей или равной
indexв этом списке; -1, если элемент не найден. - Исключения:
-
IndexOutOfBoundsException— если указанный индекс больше или равен текущему размеру этого списка
clone
toArray
public Object[] toArray()
Возвращаемый массив является «безопасным»: этот список не хранит на него ссылок. (Другими словами, этот метод должен выделить новый массив). Поэтому вызывающий код может свободно изменять возвращаемый массив.
Этот метод служит связующим звеном между API на основе массивов и API на основе коллекций.
toArray
public <T> T[] toArray(T[] a)
Если в указанном массиве достаточно места для этого списка (то есть в массиве элементов больше, чем в списке), элемент массива, непосредственно следующий за концом списка, устанавливается в null. (Это полезно для определения длины списка только в том случае, если вызывающий код знает, что список не содержит элементов null.)
Как и метод toArray(), этот метод служит связующим звеном между API на основе массивов и API на основе коллекций. Кроме того, этот метод позволяет точно управлять типом выходного массива во время выполнения и при определённых обстоятельствах может использоваться для сокращения затрат на выделение памяти.
Предположим, что x — это список, содержащий только строки. Следующий код можно использовать для выгрузки списка в новый выделенный массив типа String:
String[] y = x.toArray(new String[0]); Обратите внимание, что toArray(new Object[0]) функционально идентичен toArray().- Определено в:
-
toArrayв интерфейсеCollection<E> - Определено в:
-
toArrayв интерфейсеList<E> - Параметры типа:
T— тип элементов массива, в котором будет храниться коллекция- Параметры:
-
a— массив, в который помещаются элементы списка, если он достаточно велик; в противном случае для этой цели выделяется новый массив того же типа во время выполнения. - Возвращает:
- массив, содержащий все элементы этого списка
- Исключения:
-
ArrayStoreException— если тип указанного массива во время выполнения не является супертипом типа во время выполнения каждого элемента этого списка -
NullPointerException— если указанный массив равен null
get
public E get(int index)
- Определено в:
-
getв интерфейсеList<E> - Параметры:
-
index— индекс возвращаемого элемента - Возвращает:
- элемент, находящийся в указанной позиции этого списка
- Исключения:
-
IndexOutOfBoundsException— если индекс выходит за пределы допустимого диапазона (index < 0 || index >= size())
getFirst
public E getFirst()
- Определено в:
-
getFirstв интерфейсеList<E> - Определено в:
-
getFirstв интерфейсеSequencedCollection<E> - Возвращает:
- извлечённый элемент
- Исключения:
-
NoSuchElementException— если эта коллекция пуста - Начиная с:
- 21
getLast
public E getLast()
- Определено в:
-
getLastв интерфейсеList<E> - Определено в:
-
getLastв интерфейсеSequencedCollection<E> - Возвращает:
- извлечённый элемент
- Исключения:
-
NoSuchElementException— если эта коллекция пуста - Начиная с:
- 21
set
public E set(int index, E element)
- Определено в:
-
setв интерфейсеList<E> - Параметры:
-
index— индекс заменяемого элемента -
element— элемент, который будет сохранён в указанной позиции - Возвращает:
- элемент, ранее находившийся в указанной позиции
- Исключения:
-
IndexOutOfBoundsException— если индекс выходит за пределы допустимого диапазона (index < 0 || index >= size())
add
public boolean add(E e)
- Определено в:
-
addв интерфейсеCollection<E> - Определено в:
-
addв интерфейсеList<E> - Параметры:
-
e— элемент, добавляемый в конец этого списка - Возвращает:
-
true(как указано вCollection.add(E))
add
public void add(int index, E element)
- Определено в:
-
addв интерфейсеList<E> - Параметры:
-
index— позиция, в которую следует вставить указанный элемент -
element— вставляемый элемент - Исключения:
-
IndexOutOfBoundsException— если индекс выходит за пределы допустимого диапазона (index < 0 || index > size())
addFirst
public void addFirst(E e)
addLast
public void addLast(E e)
remove
public E remove(int index)
- Определено в:
-
removeв интерфейсеList<E> - Параметры:
-
index— индекс удаляемого элемента - Возвращает:
- элемент, ранее находившийся в указанной позиции
- Исключения:
-
IndexOutOfBoundsException— если индекс выходит за пределы допустимого диапазона (index < 0 || index >= size())
removeFirst
public E removeFirst()
- Определено в:
-
removeFirstв интерфейсеList<E> - Определено в:
-
removeFirstв интерфейсеSequencedCollection<E> - Возвращает:
- удалённый элемент
- Исключения:
-
NoSuchElementException— если эта коллекция пуста - Начиная с:
- 21
removeLast
public E removeLast()
- Определено в:
-
removeLastв интерфейсеList<E> - Определено в:
-
removeLastв интерфейсеSequencedCollection<E> - Возвращает:
- удалённый элемент
- Исключения:
-
NoSuchElementException— если эта коллекция пуста - Начиная с:
- 21
remove
public boolean remove(Object o)
i, для которого Objects.equals(o, get(i)) (если такой элемент существует). Возвращает true, если этот список содержал указанный элемент (или, что равнозначно, если в результате вызова список изменился).addIfAbsent
public boolean addIfAbsent(E e)
- Параметры:
-
e— элемент, который нужно добавить в этот список, если он отсутствует - Возвращает:
-
true, если элемент был добавлен
containsAll
public boolean containsAll(Collection<?> c)
true, если этот список содержит все элементы указанной коллекции.- Определено в:
-
containsAllв интерфейсеCollection<E> - Определено в:
-
containsAllв интерфейсеList<E> - Параметры:
-
c— коллекция, наличие элементов которой в этом списке проверяется - Возвращает:
-
true, если этот список содержит все элементы указанной коллекции - Исключения:
-
NullPointerException— если указанная коллекция равна null - См. также:
removeAll
public boolean removeAll(Collection<?> c)
- Определено в:
-
removeAllв интерфейсеCollection<E> - Определено в:
-
removeAllв интерфейсеList<E> - Параметры:
-
c— коллекция, содержащая элементы, которые нужно удалить из этого списка - Возвращает:
-
true, если в результате вызова этот список изменился - Исключения:
-
ClassCastException— если класс элемента этого списка несовместим с указанной коллекцией (необязательно) -
NullPointerException— если этот список содержит элемент null, а указанная коллекция не допускает элементы null (необязательно), или если указанная коллекция равна null - См. также:
retainAll
public boolean retainAll(Collection<?> c)
- Определено в:
-
retainAllв интерфейсеCollection<E> - Определено в:
-
retainAllв интерфейсеList<E> - Параметры:
-
c— коллекция, содержащая элементы, которые нужно оставить в этом списке - Возвращает:
-
true, если в результате вызова этот список изменился - Исключения:
-
ClassCastException— если класс элемента этого списка несовместим с указанной коллекцией (необязательно) -
NullPointerException— если этот список содержит элемент null, а указанная коллекция не допускает элементы null (необязательно), или если указанная коллекция равна null - См. также:
addAllAbsent
public int addAllAbsent(Collection<? extends E> c)
- Параметры:
-
c— коллекция, содержащая элементы, которые нужно добавить в этот список - Возвращает:
- количество добавленных элементов
- Исключения:
-
NullPointerException— если указанная коллекция равна null - См. также:
clear
addAll
public boolean addAll(Collection<? extends E> c)
- Определено в:
-
addAllв интерфейсеCollection<E> - Определено в:
-
addAllв интерфейсеList<E> - Параметры:
-
c— коллекция, содержащая элементы, которые нужно добавить в этот список - Возвращает:
-
true, если в результате вызова этот список изменился - Исключения:
-
NullPointerException— если указанная коллекция равна null - См. также:
addAll
public boolean addAll(int index, Collection<? extends E> c)
- Определено в:
-
addAllв интерфейсеList<E> - Параметры:
-
index— позиция, в которую нужно вставить первый элемент указанной коллекции -
c— коллекция, содержащая элементы, которые нужно добавить в этот список - Возвращает:
-
true, если в результате вызова этот список изменился - Исключения:
-
IndexOutOfBoundsException— если индекс выходит за пределы допустимого диапазона (index < 0 || index > size()) -
NullPointerException— если указанная коллекция равна null - См. также:
forEach
public void forEach(Consumer<? super E> action)
IterableIterable, пока не будут обработаны все элементы или действие не вызовет исключение. Если порядок итерации определён, действия выполняются в этом порядке. Исключения, вызванные действием, передаются вызывающему коду. Поведение этого метода не определено, если действие производит побочные эффекты, изменяющие исходный источник элементов, кроме случаев, когда переопределяющий класс задаёт политику параллельной модификации.
- Определено в:
-
forEachв интерфейсеIterable<E> - Параметры:
-
action— действие, выполняемое для каждого элемента - Исключения:
-
NullPointerException— если указанное действие равно null
removeIf
public boolean removeIf(Predicate<? super E> filter)
Collection- Определено в:
-
removeIfв интерфейсеCollection<E> - Параметры:
-
filter— предикат, возвращающийtrueдля элементов, которые нужно удалить - Возвращает:
-
true, если были удалены какие-либо элементы - Исключения:
-
NullPointerException— если указанный фильтр равен null
toString
public String toString()
"[]"). Соседние элементы разделяются символами ", " (запятая и пробел). Элементы преобразуются в строки так же, как при вызове String.valueOf(Object).equals
public boolean equals(Object o)
true, если указанный объект является тем же объектом, что и этот объект, либо если он также является List и последовательность элементов, возвращаемых итератором iterator для указанного списка, совпадает с последовательностью, возвращаемой итератором для этого списка. Две последовательности считаются одинаковыми, если они имеют одинаковую длину, а соответствующие элементы, находящиеся на одной и той же позиции в последовательности, равны. Два элемента e1 и e2 считаются равными, если Objects.equals(e1, e2).hashCode
public int hashCode()
Эта реализация использует определение из List.hashCode().
iterator
public Iterator<E> iterator()
Возвращаемый итератор предоставляет снимок состояния списка на момент создания итератора. При обходе итератора синхронизация не требуется. Итератор НЕ поддерживает метод remove.
listIterator
public ListIterator<E> listIterator()
Возвращаемый итератор предоставляет снимок состояния списка на момент создания итератора. При обходе итератора синхронизация не требуется. Итератор НЕ поддерживает методы remove, set или add.
- Определено в:
-
listIteratorв интерфейсеList<E> - Возвращает:
- итератор списка по элементам этого списка (в надлежащем порядке)
listIterator
public ListIterator<E> listIterator(int index)
next. Первоначальный вызов previous вернет элемент с индексом на единицу меньше указанного. Возвращаемый итератор предоставляет снимок состояния списка на момент создания итератора. При обходе итератора синхронизация не требуется. Итератор НЕ поддерживает методы remove, set или add.
- Определено в:
-
listIteratorв интерфейсеList<E> - Параметры:
-
index- индекс первого элемента, возвращаемого итератором списка (при вызовеnext) - Возвращает:
- итератор списка по элементам этого списка (в надлежащем порядке), начиная с указанной позиции в списке
- Выбрасывает:
-
IndexOutOfBoundsException- если индекс выходит за допустимый диапазон (index < 0 || index > size())
spliterator
public Spliterator<E> spliterator()
Spliterator для элементов этого списка. Spliterator сообщает о характеристиках Spliterator.IMMUTABLE, Spliterator.ORDERED, Spliterator.SIZED и Spliterator.SUBSIZED.
Сплитератор предоставляет снимок состояния списка на момент создания сплитератора. При работе со сплитератором синхронизация не требуется.
- Определено в:
-
spliteratorв интерфейсеCollection<E> - Определено в:
-
spliteratorв интерфейсеIterable<E> - Определено в:
-
spliteratorв интерфейсеList<E> - Возвращает:
Spliteratorдля элементов этого списка- С версии:
- 1.8
subList
public List<E> subList(int fromIndex, int toIndex)
fromIndex включительно и toIndex исключительно. Возвращаемый список связан с этим списком, поэтому изменения в возвращаемом списке отражаются в этом списке. Семантика списка, возвращаемого этим методом, становится неопределенной, если исходный список (то есть этот список) изменяется каким-либо образом иначе, чем через возвращаемый список.
- Определено в:
-
subListв интерфейсеList<E> - Параметры:
-
fromIndex- нижняя граница (включительно) подсписка -
toIndex- верхняя граница (исключительно) подсписка - Возвращает:
- представление указанного диапазона в этом списке
- Выбрасывает:
-
IndexOutOfBoundsException- при недопустимом значении индекса границы (fromIndex < 0 || toIndex > size || fromIndex > toIndex)
reversed
public List<E> reversed()
Изменения представления с обратным порядком разрешены и будут передаваться этому списку. Кроме того, изменения этого списка будут видны в представлении с обратным порядком. Для подсписков и итераторов представления с обратным порядком действуют те же ограничения, что и для этого списка.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/concurrent/CopyOnWriteArrayList.html