Класс ConcurrentLinkedQueue<E>
- Параметры типа:
E— тип элементов, хранящихся в этой очереди
- Все реализуемые интерфейсы:
Serializable, Iterable<E>, Collection<E>, Queue<E>
public class ConcurrentLinkedQueue<E> extends AbstractQueue<E> implements Queue<E>, Serializable
ConcurrentLinkedQueue — подходящий выбор, когда доступ к общей коллекции будут использовать многие потоки. Как и большинство других реализаций параллельных коллекций, этот класс не допускает использование элементов null. В этой реализации используется эффективный неблокирующий алгоритм, основанный на алгоритме, описанном в работе Простые, быстрые и практичные неблокирующие и блокирующие алгоритмы параллельных очередей Мэджа М. Майкла и Майкла Л. Скотта.
Итераторы являются слабо согласованными и возвращают элементы, отражающие состояние очереди в момент создания итератора или после него. Они не выбрасывают ConcurrentModificationException и могут выполняться параллельно с другими операциями. Элементы, содержащиеся в очереди с момента создания итератора, будут возвращены ровно один раз.
Следует учитывать, что, в отличие от большинства коллекций, метод size НЕ выполняется за постоянное время. Из-за асинхронной природы этих очередей определение текущего числа элементов требует их обхода и поэтому может дать неточный результат, если эта коллекция изменяется во время обхода.
Групповые операции, добавляющие, удаляющие или проверяющие несколько элементов, такие как addAll(Collection), removeIf(Predicate) или forEach(Consumer), не гарантированно выполняются атомарно. Например, обход forEach, выполняющийся параллельно с операцией
addAll, может увидеть только некоторые из добавленных элементов.
Этот класс и его итератор реализуют все необязательные методы интерфейсов Queue и Iterator.
Эффекты согласованности памяти: как и в других параллельных коллекциях, действия в потоке, предшествующие помещению объекта в ConcurrentLinkedQueue, происходят до действий, следующих за доступом к этому элементу или его удалением из ConcurrentLinkedQueue в другом потоке.
Этот класс является частью Java Collections Framework.
- С версии:
- 1.5
- См. также:
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
ConcurrentLinkedQueue() |
Создаёт ConcurrentLinkedQueue, изначально пустую. |
ConcurrentLinkedQueue |
Создаёт ConcurrentLinkedQueue, изначально содержащую элементы заданной коллекции, добавленные в порядке обхода итератором коллекции. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
add |
Вставляет указанный элемент в хвост этой очереди. |
boolean |
addAll |
Добавляет все элементы указанной коллекции в конец этой очереди в том порядке, в котором их возвращает итератор указанной коллекции. |
boolean |
contains |
Возвращает true, если эта очередь содержит указанный элемент. |
void |
forEach |
Выполняет указанное действие для каждого элемента Iterable, пока не будут обработаны все элементы или действие не выбросит исключение. |
boolean |
isEmpty() |
Возвращает true, если эта очередь не содержит элементов. |
Iterator |
iterator() |
Возвращает итератор элементов этой очереди в надлежащем порядке. |
boolean |
offer |
Вставляет указанный элемент в хвост этой очереди. |
E |
peek() |
Извлекает, но не удаляет голову этой очереди; если очередь пуста, возвращает null. |
E |
poll() |
Извлекает и удаляет голову этой очереди; если очередь пуста, возвращает null. |
boolean |
remove |
Удаляет один экземпляр указанного элемента из этой очереди, если он присутствует. |
boolean |
removeAll |
Удаляет из этой коллекции все элементы, которые также содержатся в указанной коллекции (необязательная операция). |
boolean |
removeIf |
Удаляет из этой коллекции все элементы, удовлетворяющие заданному предикату (необязательная операция). |
boolean |
retainAll |
Оставляет в этой коллекции только элементы, содержащиеся в указанной коллекции (необязательная операция). |
int |
size() |
Возвращает число элементов в этой очереди. |
Spliterator |
spliterator() |
Возвращает Spliterator для элементов этой очереди. |
Object[] |
toArray() |
Возвращает массив, содержащий все элементы этой очереди в надлежащем порядке. |
<T> T[] |
toArray |
Возвращает массив, содержащий все элементы этой очереди в надлежащем порядке; тип возвращаемого массива во время выполнения совпадает с типом указанного массива. |
Методы, объявленные в классе AbstractQueue
clear, element, remove | Модификатор и тип | Метод | Описание |
|---|---|---|
void |
clear() |
Удаляет все элементы из этой очереди. |
E |
element() |
Извлекает, но не удаляет голову этой очереди. |
E |
remove() |
Извлекает и удаляет голову этой очереди. |
Методы, объявленные в классе AbstractCollection
containsAll, toString | Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
containsAll |
Возвращает true, если эта коллекция содержит все элементы указанной коллекции. |
String |
toString() |
Возвращает строковое представление этой коллекции. |
Методы, объявленные в классе Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
protected Object |
clone() |
Создаёт и возвращает копию этого объекта. |
boolean |
equals |
Указывает, равен ли этот объект другому объекту. |
protected void |
finalize() |
Устарело, будет удалено: этот элемент API может быть удалён в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков. |
final Class |
getClass() |
Возвращает класс этого Object во время выполнения. |
int |
hashCode() |
Возвращает хеш-код этого объекта. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
final void |
wait() |
Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или interrupt. |
final void |
wait |
Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени. |
final void |
wait |
Заставляет текущий поток ждать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени. |
Методы, объявленные в интерфейсе Collection
equals, hashCode, parallelStream, stream, toArray | Модификатор и тип | Метод | Описание |
|---|---|---|
boolean |
equals |
Сравнивает указанный объект с этой коллекцией на равенство. |
int |
hashCode() |
Возвращает значение хеш-кода этой коллекции. |
default Stream |
parallelStream() |
Возвращает, возможно, параллельный Stream, источником которого является эта коллекция. |
default Stream |
stream() |
Возвращает последовательный Stream, источником которого является эта коллекция. |
default <T> T[] |
toArray |
Возвращает массив, содержащий все элементы этой коллекции; для выделения возвращаемого массива используется предоставленная функция generator. |
Подробное описание конструкторов
ConcurrentLinkedQueue
public ConcurrentLinkedQueue()
ConcurrentLinkedQueue, изначально пустую.ConcurrentLinkedQueue
public ConcurrentLinkedQueue(Collection<? extends E> c)
ConcurrentLinkedQueue, изначально содержащую элементы заданной коллекции, добавленные в порядке обхода итератора коллекции.- Параметры:
-
c— коллекция элементов, которые должны содержаться изначально - Исключения:
-
NullPointerException— если заданная коллекция или любой из ее элементов равны null
Подробное описание методов
add
public boolean add(E e)
IllegalStateException и не возвращает false.- Определен в:
-
addв интерфейсеCollection<E> - Определен в:
-
addв интерфейсеQueue<E> - Переопределяет:
-
addв классеAbstractQueue<E> - Параметры:
-
e— добавляемый элемент - Возвращает:
-
true(как указано вCollection.add(E)) - Исключения:
-
NullPointerException— если указанный элемент равен null
offer
public boolean offer(E e)
false.- Определен в:
-
offerв интерфейсеQueue<E> - Параметры:
-
e— добавляемый элемент - Возвращает:
-
true(как указано вQueue.offer(E)) - Исключения:
-
NullPointerException— если указанный элемент равен null
poll
peek
isEmpty
public boolean isEmpty()
true, если очередь не содержит элементов.- Определен в:
-
isEmptyв интерфейсеCollection<E> - Переопределяет:
-
isEmptyв классеAbstractCollection<E> - Возвращает:
-
true, если очередь не содержит элементов
size
public int size()
Integer.MAX_VALUE элементов, возвращает Integer.MAX_VALUE. Следует учитывать, что, в отличие от большинства коллекций, этот метод НЕ выполняется за постоянное время. Из-за асинхронной природы этих очередей определение текущего количества элементов требует обхода за O(n). Кроме того, если во время выполнения этого метода элементы добавляются или удаляются, возвращаемый результат может быть неточным. Поэтому этот метод обычно не очень полезен в параллельных приложениях.
- Определен в:
-
sizeв интерфейсеCollection<E> - Возвращает:
- количество элементов в этой очереди
contains
public boolean contains(Object o)
true, если эта очередь содержит указанный элемент. Точнее, возвращает true тогда и только тогда, когда эта очередь содержит хотя бы один элемент e, такой что o.equals(e).- Определен в:
-
containsв интерфейсеCollection<E> - Переопределяет:
-
containsв классеAbstractCollection<E> - Параметры:
-
o— объект, наличие которого в этой очереди нужно проверить - Возвращает:
-
true, если эта очередь содержит указанный элемент
remove
public boolean remove(Object o)
e, такой что o.equals(e), если очередь содержит один или несколько таких элементов. Возвращает true, если очередь содержала указанный элемент (или, что эквивалентно, если в результате вызова очередь изменилась).- Определен в:
-
removeв интерфейсеCollection<E> - Переопределяет:
-
removeв классеAbstractCollection<E> - Параметры:
-
o— элемент, который следует удалить из этой очереди, если он присутствует - Возвращает:
-
true, если в результате вызова очередь изменилась
addAll
public boolean addAll(Collection<? extends E> c)
addAll очереди в саму себя приводят к IllegalArgumentException.- Определен в:
-
addAllв интерфейсеCollection<E> - Переопределяет:
-
addAllв классеAbstractQueue<E> - Параметры:
-
c— элементы, которые нужно вставить в эту очередь - Возвращает:
-
true, если в результате вызова очередь изменилась - Исключения:
-
NullPointerException— если указанная коллекция или любой из ее элементов равны null -
IllegalArgumentException— если коллекция является этой очередью - См. также:
toArray
public Object[] toArray()
Возвращаемый массив является «безопасным» в том смысле, что эта очередь не хранит на него ссылок. (Иными словами, этот метод должен выделить новый массив). Поэтому вызывающий код может свободно изменять возвращенный массив.
Этот метод служит связующим звеном между API на основе массивов и API на основе коллекций.
- Определен в:
-
toArrayв интерфейсеCollection<E> - Переопределяет:
-
toArrayв классеAbstractCollection<E> - Возвращает:
- массив, содержащий все элементы этой очереди
toArray
public <T> T[] toArray(T[] a)
Если очередь помещается в указанный массив с запасом (то есть в массиве больше элементов, чем в очереди), элемент массива, следующий непосредственно за концом очереди, устанавливается в null.
Как и метод toArray(), этот метод служит связующим звеном между API на основе массивов и API на основе коллекций. Кроме того, этот метод позволяет точно контролировать тип выходного массива во время выполнения и при определенных обстоятельствах может использоваться для сокращения затрат на выделение памяти.
Предположим, что x — очередь, которая, как известно, содержит только строки. Следующий код можно использовать для выгрузки очереди в новый выделенный массив типа String:
String[] y = x.toArray(new String[0]); Обратите внимание, что toArray(new Object[0]) функционально идентичен toArray().- Определен в:
-
toArrayв интерфейсеCollection<E> - Переопределяет:
-
toArrayв классеAbstractCollection<E> - Параметры типа:
T— тип компонентов массива, в котором будет храниться коллекция- Параметры:
-
a— массив, в котором будут храниться элементы очереди, если он достаточно велик; в противном случае для этой цели выделяется новый массив того же типа во время выполнения - Возвращает:
- массив, содержащий все элементы этой очереди
- Исключения:
-
ArrayStoreException— если тип указанного массива во время выполнения не является супертипом типа каждого элемента этой очереди во время выполнения -
NullPointerException— если указанный массив равен null
iterator
public Iterator<E> iterator()
Возвращаемый итератор является слабо согласованным.
- Определен в:
-
iteratorв интерфейсеCollection<E> - Определен в:
-
iteratorв интерфейсеIterable<E> - Определен в:
-
iteratorв классеAbstractCollection<E> - Возвращает:
- итератор по элементам этой очереди в надлежащем порядке
spliterator
public Spliterator<E> spliterator()
Spliterator для элементов этой очереди. Возвращаемый сплитератор является слабо согласованным.
Spliterator сообщает характеристики Spliterator.CONCURRENT, Spliterator.ORDERED и Spliterator.NONNULL.
- Определен в:
-
spliteratorв интерфейсеCollection<E> - Определен в:
-
spliteratorв интерфейсеIterable<E> - Примечание по реализации:
SpliteratorреализуетtrySplit, обеспечивая ограниченный уровень параллелизма.- Возвращает:
Spliteratorдля элементов этой очереди- С версии:
- 1.8
removeIf
public boolean removeIf(Predicate<? super E> filter)
Collection- Определен в:
-
removeIfв интерфейсеCollection<E> - Параметры:
-
filter— предикат, возвращающийtrueдля удаляемых элементов - Возвращает:
-
true, если были удалены какие-либо элементы - Исключения:
-
NullPointerException— если указанный фильтр равен null
removeAll
public boolean removeAll(Collection<?> c)
AbstractCollection- Определен в:
-
removeAllв интерфейсеCollection<E> - Переопределяет:
-
removeAllв классеAbstractCollection<E> - Параметры:
-
c— коллекция, содержащая элементы, которые нужно удалить из этой коллекции - Возвращает:
-
true, если в результате вызова эта коллекция изменилась - Исключения:
-
NullPointerException— если эта коллекция содержит один или несколько элементов null, а указанная коллекция не поддерживает элементы null (необязательно), либо если указанная коллекция равна null - См. также:
retainAll
public boolean retainAll(Collection<?> c)
AbstractCollection- Определен в:
-
retainAllв интерфейсеCollection<E> - Переопределяет:
-
retainAllв классеAbstractCollection<E> - Параметры:
-
c— коллекция, содержащая элементы, которые нужно оставить в этой коллекции - Возвращает:
-
true, если в результате вызова эта коллекция изменилась - Исключения:
-
NullPointerException— если эта коллекция содержит один или несколько элементов null, а указанная коллекция не допускает элементы null (необязательно), либо если указанная коллекция равна null - См. также:
forEach
public void forEach(Consumer<? super E> action)
IterableIterable, пока не будут обработаны все элементы или действие не выбросит исключение. Если порядок итерации определен, действия выполняются в этом порядке. Исключения, выброшенные действием, передаются вызывающему коду. Поведение этого метода не определено, если действие выполняет побочные эффекты, изменяющие исходный набор элементов, за исключением случаев, когда переопределяющий класс определил политику параллельной модификации.
- Определен в:
-
forEachв интерфейсеIterable<E> - Параметры:
-
action— действие, выполняемое для каждого элемента - Исключения:
-
NullPointerException— если указанное действие равно null
© 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.