Класс CopyOnWriteArrayList<E>

Потокобезопасная версия класса ArrayList, в которой все изменяющие операции (add, set, и т. д.) реализуются путём создания свежей копии базового массива.

Обычно это слишком дорого, но может быть более эффективным, чем альтернативы, когда операции обхода значительно превосходят операции изменения, и полезно, когда вы не можете или не хотите синхронизировать обходы, но вам необходимо предотвратить вмешательство между конкурирующими потоками. Метод итератора "снимок" использует ссылку на состояние массива на момент создания итератора. Этот массив никогда не изменяется во время существования итератора, поэтому конфликты невозможны, и гарантируется, что итератор не выбросит ConcurrentModificationException. Итератор не будет отражать добавления, удаления или изменения в списке после создания итератора. Операции изменения элементов на самих итераторах (remove, set, и add) не поддерживаются. Эти методы выбрасывают UnsupportedOperationException.

Разрешены все элементы, включая null.

Эффекты согласованности памяти: Как и в других коллекциях с конкурентным доступом, действия в потоке до помещения объекта в CopyOnWriteArrayList предшествуют последующим действиям доступа или удаления этого элемента из CopyOnWriteArrayList в другом потоке.

Этот класс является частью Java Collections Framework.

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

CopyOnWriteArrayList

public CopyOnWriteArrayList()

Создаёт пустой список.

CopyOnWriteArrayList

public CopyOnWriteArrayList(Collection<? extends E> c)

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

Параметры:

c - набор изначально содержащихся элементов

Исключения:

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

CopyOnWriteArrayList

public CopyOnWriteArrayList(E[] toCopyIn)

Создаёт список, содержащий копию заданного массива.

Параметры:

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

Исключения:

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

Методы

size

public int size()

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

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

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

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

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

Возвращает:

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

isEmpty

public boolean isEmpty()

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

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

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

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

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

Возвращает:

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

contains

public boolean contains(Object o)

Возвращает true, если этот список содержит указанный элемент. Более формально, возвращает true, если и только если этот список содержит по меньшей мере один элемент , такой что .

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

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

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

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

Параметры:

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

Возвращает:

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

indexOf

public int indexOf(Object o)

Возвращает индекс первого вхождения указанного элемента в этот список или -1, если этот список не содержит элемент. Более формально, возвращает наименьший индекс , такой что , или -1, если такого индекса нет.

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

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

Параметры:

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

Возвращает:

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

indexOf

public int indexOf(E e,
                   int index)

Возвращает индекс первого вхождения указанного элемента в этот список, выполняя поиск вперёд с , или возвращает -1, если элемент не найден. Более формально, возвращает наименьший индекс , такой что , или -1, если такого индекса нет.

Параметры:

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

index - индекс, с которого следует начать поиск

Возвращает:

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

Исключения:

IndexOutOfBoundsException - если указанный индекс отрицательный

lastIndexOf

public int lastIndexOf(Object o)

Возвращает индекс последнего вхождения указанного элемента в этот список или -1, если этот список не содержит элемент. Более формально, возвращает наивысший индекс , такой что , или -1, если такого индекса нет.

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

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

Параметры:

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

Возвращает:

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

lastIndexOf

public int lastIndexOf(E e,
                       int index)

Возвращает индекс последнего вхождения указанного элемента в этот список, выполняя поиск назад с , или возвращает -1, если элемент не найден. Более формально, возвращает наивысший индекс , такой что , или -1, если такого индекса нет.

Параметры:

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

index - индекс, с которого следует начать поиск назад

Возвращает:

индекс последнего вхождения элемента с позиции меньше или равной в этом списке; -1, если элемент не найден.

Исключения:

IndexOutOfBoundsException - если указанный индекс больше или равен текущему размеру этого списка

clone

public Object clone()

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

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

clone в классе Object

Возвращает:

клонированный список

См. также:

Cloneable

toArray

public Object[] toArray()

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

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

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

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

Возвращает:

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

См. также:

Arrays.asList(Object[])

toArray

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

String[] y = x.toArray(new String[0]);

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

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

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 (как указано в )

add

public void add(int index,
                E element)

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

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

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

Параметры:

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

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

Исключения:

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

remove

public E remove(int index)

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

Указано в:

remove в интерфейсе List<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>

Параметры:

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

Возвращает:

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

См. также:

contains(Object)

removeAll

public boolean removeAll(Collection<?> c)

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

Указано в:

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

Указано в:

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

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

См. также:

remove(Object)

retainAll

public boolean retainAll(Collection<?> c)

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

Указано в:

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

Указано в:

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

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

См. также:

remove(Object)

addAllAbsent

public int addAllAbsent(Collection<? extends E> c)

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

Параметры:

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

Возвращает:

количество добавленных элементов

Выбрасывает:

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

См. также:

addIfAbsent(Object)

clear

public void clear()

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

Указано в:

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

Указано в:

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

addAll

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

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

Указано в:

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

Указано в:

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

Параметры:

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

Возвращает:

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

Выбрасывает:

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

См. также:

add(Object)

addAll

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

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

Выбрасывает:

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

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

См. также:

add(int,Object)

forEach

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

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

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

Указано в:

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

Параметры:

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

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 указывает на то, что должен использоваться естественный порядок элементов

toString

public String toString()

Возвращает строковое представление этого списка. Строковое представление состоит из строковых представлений элементов списка в порядке, в котором они возвращаются его итератором, заключённых в квадратные скобки ("[]"). Смежные элементы разделяются символами ", " (запятая и пробел). Элементы преобразуются в строки с помощью String.valueOf(Object).

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

toString в классе Object

Возвращает:

строковое представление этого списка

equals

public boolean equals(Object o)

Сравнивает указанный объект с этим списком на равенство. Возвращает true, если указанный объект является тем же объектом, что и этот объект, или если это также List и последовательность элементов, возвращаемых итератором над указанным списком, совпадает с последовательностью, возвращаемой итератором над этим списком. Две последовательности считаются одинаковыми, если они имеют одинаковую длину и соответствующие элементы в одинаковых позициях в последовательности равны. Два элемента e1 и e2 считаются равными, если (e1==null ? e2==null : e1.equals(e2)).

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

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

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

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

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

equals в классе Object

Параметры:

o - объект, который нужно сравнить на равенство с этим списком

Возвращает:

true, если указанный объект равен этому списку

См. также:

Object.hashCode(), HashMap

hashCode

public int hashCode()

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

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

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

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

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

hashCode в классе Object

Возвращает:

значение хэш-кода для этого списка

См. также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

iterator

public Iterator<E> iterator()

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

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

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

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

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

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

Возвращает:

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

listIterator

public ListIterator<E> listIterator()

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

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

Возвращает:

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

listIterator

public ListIterator<E> listIterator(int index)

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

spliterator

public Spliterator<E> spliterator()

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

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

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

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

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

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

Возвращает:

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

С тех пор:

1.8

subList

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

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

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

Параметры:

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

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

Возвращает:

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

Исключения:

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