Spec-Zone.ru › OpenJDK 17

Класс AbstractQueue<E>

java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractQueue<E>
Параметры типа:
E - тип элементов, хранящихся в этой очереди
Все реализованные интерфейсы:
Iterable<E>, Collection<E>, Queue<E>
Прямые известные подклассы:
ArrayBlockingQueue, ConcurrentLinkedQueue, DelayQueue, LinkedBlockingDeque, LinkedBlockingQueue, LinkedTransferQueue, PriorityBlockingQueue, PriorityQueue, SynchronousQueue
public abstract class AbstractQueue<E> extends AbstractCollection<E> implements Queue<E>
Этот класс предоставляет скелетные реализации некоторых операций Queue. Реализации в этом классе подходят в тех случаях, когда базовая реализация не допускает null элементы. Методы add, remove и element основаны на offer, poll и peek соответственно, но вместо этого выбрасывают исключения, вместо того, чтобы указывать неудачу с помощью false или null возвращений.

Реализация Queue класса, расширяющего этот класс, должна минимально определять метод Queue.offer(E), который не допускает вставки null элементов, а также методы Queue.peek(), Queue.poll(), Collection.size() и Collection.iterator(). Как правило, будут переопределены и дополнительные методы. Если эти требования не могут быть выполнены, следует вместо этого рассмотреть возможность создания подкласса AbstractCollection.

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

С:
1.5

Краткое описание конструкторов

AbstractQueue()
Модификатор Конструктор Описание
protected
Конструктор для использования подклассами.

Краткое описание методов

Модификатор и тип Метод Описание
boolean add(E e)
Вставляет указанный элемент в эту очередь, если это возможно сделать немедленно, не нарушая ограничений по емкости, возвращая true при успехе и выбрасывая IllegalStateException если в настоящее время места нет.
boolean addAll(Collection<? extends E> c)
Добавляет все элементы из указанного набора в эту очередь.
void clear()
Удаляет все элементы из этой очереди.
E element()
Возвращает, но не удаляет, голову этой очереди.
E remove()
Возвращает и удаляет голову этой очереди.

Методы, объявленные в классе java.util.AbstractCollection

contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, toArray, toArray, toString

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray, toArray

Методы, объявленные в интерфейсе java.lang.Iterable

forEach

Методы, объявленные в интерфейсе java.util.Queue

offer, peek, poll

Подробное описание конструкторов

AbstractQueue

protected AbstractQueue()
Конструктор для использования подклассами.

Подробное описание методов

add

public boolean add(E e)
Вставляет указанный элемент в эту очередь, если это возможно сделать немедленно, не нарушая ограничений по емкости, возвращая true при успехе и выбрасывая IllegalStateException если в настоящее время места нет.

Эта реализация возвращает true если offer успешно, в противном случае выбрасывает IllegalStateException.

Определено в:
add в интерфейсе Collection<E>
Определено в:
add в интерфейсе Queue<E>
Переопределяет:
add в классе AbstractCollection<E>
Параметры:
e - элемент для добавления
Возвращает:
true (как указано в Collection.add(E))
Исключения:
IllegalStateException - если элемент не может быть добавлен в данный момент из-за ограничений по емкости
ClassCastException - если класс указанного элемента препятствует его добавлению в эту очередь
NullPointerException - если указанный элемент равен null, и эта очередь не допускает null-элементы
IllegalArgumentException - если какая-то характеристика этого элемента препятствует его добавлению в эту очередь

remove

public E remove()
Возвращает и удаляет голову этой очереди. Этот метод отличается от poll только тем, что выбрасывает исключение, если эта очередь пуста.

Эта реализация возвращает результат poll если очередь не пуста.

Определено в:
remove в интерфейсе Queue<E>
Возвращает:
голова этой очереди
Исключения:
NoSuchElementException - если эта очередь пуста

element

public E element()
Возвращает, но не удаляет, голову этой очереди. Этот метод отличается от peek только тем, что выбрасывает исключение, если эта очередь пуста.

Эта реализация возвращает результат peek если очередь не пуста.

Определено в:
element в интерфейсе Queue<E>
Возвращает:
голова этой очереди
Исключения:
NoSuchElementException - если эта очередь пуста

clear

public void clear()
Удаляет все элементы из этой очереди. Очередь будет пуста после возвращения этого вызова.

Эта реализация многократно вызывает poll, пока не вернёт null.

Определено в:
clear в интерфейсе Collection<E>
Переопределяет:
clear в классе AbstractCollection<E>

addAll

public boolean addAll(Collection<? extends E> c)
Добавляет все элементы из указанного набора в эту очередь. Попытки добавить все элементы из очереди в саму себя приводят к IllegalArgumentException. Кроме того, поведение этой операции не определено, если указанный набор модифицируется во время выполнения операции.

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

Определено в:
addAll в интерфейсе Collection<E>
Переопределяет:
addAll в классе AbstractCollection<E>
Параметры:
c - набор, содержащий элементы, которые должны быть добавлены в эту очередь
Возвращает:
true если эта очередь изменилась в результате вызова
Исключения:
ClassCastException - если класс элемента указанного набора препятствует его добавлению в эту очередь
NullPointerException - если указанный набор содержит null-элемент и эта очередь не допускает null-элементы, или если указанный набор равен null
IllegalArgumentException - если какая-то характеристика элемента указанного набора препятствует его добавлению в эту очередь, или если указанный набор является этой очередью
IllegalStateException - если не все элементы могут быть добавлены в данный момент из-за ограничений вставки
См. также:
  • add(Object)

© 1993, 2021, 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/17/docs/api/java.base/java/util/AbstractQueue.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API