java.util

Интерфейсная Двухсторонняя очередь <E>

Введите Параметры:

E - тип элементов сохранен в этом наборе

Все Суперинтерфейсы:

Набор <E>, Повторяемый <E>, Очередь <E>

Все Известные Подынтерфейсы:

BlockingDeque <E>

Все Известные Классы с реализацией:

ArrayDeque, ConcurrentLinkedDeque, LinkedBlockingDeque, LinkedList

public interface Deque<E>
extends Queue<E>

Линейный набор, который поддерживает вставку элемента и удаление в обоих концах. Двухсторонняя очередь имени коротка для "очереди с двусторонним доступом" и обычно объявляется "декой". Большинство реализаций Deque не устанавливает фиксированных границ числа элементов, которое они могут содержать, но этот интерфейс поддерживает ограниченные емкостью двухсторонние очереди так же как тех без предела фиксированного размера.

Этот интерфейс определяет методы, чтобы получить доступ к элементам в обоих концах двухсторонней очереди. Методы обеспечиваются, чтобы вставить, удалить, и исследовать элемент. Каждый из этих методов существует в двух формах: каждый выдает исключение, если работа перестала работать, другие возвраты специальное значение (или null или false, в зависимости от работы). Последняя форма работы вставки специально разработана для использования с ограниченными емкостью реализациями Deque; в большинстве реализаций вставьте операции, не может перестать работать.

Эти двенадцать методов, описанных выше, получаются в итоге в следующей таблице:

	Первый Элемент (Голова)		Последний Элемент (Хвост)
	Выдает исключение	Специальное значение	Выдает исключение	Специальное значение
Вставить	addFirst(e)	offerFirst(e)	addLast(e)	offerLast(e)
Удалить	removeFirst()	pollFirst()	removeLast()	pollLast()
Исследовать	getFirst()	peekFirst()	getLast()	peekLast()

Этот интерфейс расширяется Queue интерфейс. Когда двухсторонняя очередь используется в качестве очереди, FIFO (Первым прибыл - первым убыл) результаты поведения. Элементы добавляются в конце двухсторонней очереди и удаляются с начала. Методы, наследованные от интерфейса Queue, точно эквивалентны методам Deque как обозначено в следующей таблице:

Метод Queue	Эквивалентный Метод Deque
add(e)	addLast(e)
offer(e)	offerLast(e)
remove()	removeFirst()
poll()	pollFirst()
element()	getFirst()
peek()	peekFirst()

Двухсторонние очереди могут также использоваться, поскольку LIFO (В обратном порядке) складывает. Этот интерфейс должен использоваться в предпочтении к наследству Stack класс. Когда двухсторонняя очередь используется в качестве стека, элементы продвигаются и выталкиваются с начала двухсторонней очереди. Методы стека точно эквивалентны методам Deque как обозначено в таблице ниже:

Метод стека	Эквивалентный Метод Deque
push(e)	addFirst(e)
pop()	removeFirst()
peek()	peekFirst()

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

Этот интерфейс обеспечивает два метода, чтобы удалить внутренние элементы, removeFirstOccurrence и removeLastOccurrence.

В отличие от этого List интерфейс, этот интерфейс не оказывает поддержку для индексного доступа к элементам.

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

Реализации Deque обычно не определяют основанные на элементе версии методов equals И hashCode, но вместо этого наследовали основанные на идентификационных данных версии от класса Object.

Этот интерфейс является элементом Платформы Наборов Java.

С тех пор:

1.6

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
boolean	add(E e) Вставляет указанный элемент в очередь, представленную этой двухсторонней очередью (другими словами, в хвосте этой двухсторонней очереди), если возможно сделать так сразу, не нарушая ограничения емкости, возвращая true на успех и бросая IllegalStateException, если никакое пространство не в настоящий момент доступно.
void	addFirst(E e) Вставляет указанный элемент впереди этой двухсторонней очереди, если возможно сделать так сразу, не нарушая ограничения емкости.
void	addLast(E e) Вставляет указанный элемент в конце этой двухсторонней очереди, если возможно сделать так сразу, не нарушая ограничения емкости.
boolean	contains(Object o) true возвратов, если эта двухсторонняя очередь содержит указанный элемент.
Iterator<E>	descendingIterator() Возвращает iterator по элементам в этой двухсторонней очереди в обратном последовательном порядке.
E	element() Получает, но не удаляет, глава очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди).
E	getFirst() Получает, но не удаляет, первый элемент этой двухсторонней очереди.
E	getLast() Получает, но не удаляет, последний элемент этой двухсторонней очереди.
Iterator<E>	iterator() Возвращает iterator по элементам в этой двухсторонней очереди в надлежащей последовательности.
boolean	offer(E e) Вставляет указанный элемент в очередь, представленную этой двухсторонней очередью (другими словами, в хвосте этой двухсторонней очереди), если возможно сделать так сразу, не нарушая ограничения емкости, возвращая true на успех и false, если никакое пространство не в настоящий момент доступно.
boolean	offerFirst(E e) Вставляет указанный элемент впереди этой двухсторонней очереди, если это не нарушило бы ограничения емкости.
boolean	offerLast(E e) Вставляет указанный элемент в конце этой двухсторонней очереди, если это не нарушило бы ограничения емкости.
E	peek() Получает, но не удаляет, глава очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди), или возвращает null, если эта двухсторонняя очередь пуста.
E	peekFirst() Получает, но не удаляет, первый элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.
E	peekLast() Получает, но не удаляет, последний элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.
E	poll() Получает и удаляет главу очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди), или возвращает null, если эта двухсторонняя очередь пуста.
E	pollFirst() Получает и удаляет первый элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.
E	pollLast() Получает и удаляет последний элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.
E	pop() Выталкивает элемент от стека, представленного этой двухсторонней очередью.
void	push(E e) Продвигает элемент на стек, представленный этой двухсторонней очередью (другими словами, во главе этой двухсторонней очереди), если возможно сделать так сразу, не нарушая ограничения емкости, возвращая true на успех и бросая IllegalStateException, если никакое пространство не в настоящий момент доступно.
E	remove() Получает и удаляет главу очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди).
boolean	remove(Object o) Удаляет первое возникновение указанного элемента от этой двухсторонней очереди.
E	removeFirst() Получает и удаляет первый элемент этой двухсторонней очереди.
boolean	removeFirstOccurrence(Object o) Удаляет первое возникновение указанного элемента от этой двухсторонней очереди.
E	removeLast() Получает и удаляет последний элемент этой двухсторонней очереди.
boolean	removeLastOccurrence(Object o) Удаляет последнее вхождение указанного элемента от этой двухсторонней очереди.
int	size() Возвращает число элементов в этой двухсторонней очереди.

Методы, наследованные от интерфейса java.util. Набор

addAll, clear, containsAll, equals, hashCode, isEmpty, removeAll, retainAll, toArray, toArray

Деталь метода

addFirst

void addFirst(E e)

Вставляет указанный элемент впереди этой двухсторонней очереди, если возможно сделать так сразу, не нарушая ограничения емкости. При использовании ограниченной емкостью двухсторонней очереди обычно предпочтительно использовать метод offerFirst(E).

Параметры:

e - элемент, чтобы добавить

Броски:

IllegalStateException - если элемент не может быть добавлен в это время из-за ограничений емкости

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

addLast

void addLast(E e)

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

Этот метод эквивалентен add(E).

Параметры:

e - элемент, чтобы добавить

Броски:

IllegalStateException - если элемент не может быть добавлен в это время из-за ограничений емкости

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

offerFirst

boolean offerFirst(E e)

Вставляет указанный элемент впереди этой двухсторонней очереди, если это не нарушило бы ограничения емкости. При использовании ограниченной емкостью двухсторонней очереди этот метод обычно предпочтителен для addFirst(E) метод, который может быть не в состоянии вставить элемент только, выдавая исключение.

Параметры:

e - элемент, чтобы добавить

Возвраты:

true, если элемент был добавлен к этой двухсторонней очереди, еще false

Броски:

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

offerLast

boolean offerLast(E e)

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

Параметры:

e - элемент, чтобы добавить

Возвраты:

true, если элемент был добавлен к этой двухсторонней очереди, еще false

Броски:

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

removeFirst

E removeFirst()

Получает и удаляет первый элемент этой двухсторонней очереди. Этот метод отличается от pollFirst только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Возвраты:

глава этой двухсторонней очереди

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

removeLast

E removeLast()

Получает и удаляет последний элемент этой двухсторонней очереди. Этот метод отличается от pollLast только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Возвраты:

хвост этой двухсторонней очереди

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

pollFirst

E pollFirst()

Получает и удаляет первый элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.

Возвраты:

глава этой двухсторонней очереди, или null, если эта двухсторонняя очередь пуста

pollLast

E pollLast()

Получает и удаляет последний элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.

Возвраты:

хвост этой двухсторонней очереди, или null, если эта двухсторонняя очередь пуста

getFirst

E getFirst()

Получает, но не удаляет, первый элемент этой двухсторонней очереди. Этот метод отличается от peekFirst только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Возвраты:

глава этой двухсторонней очереди

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

getLast

E getLast()

Получает, но не удаляет, последний элемент этой двухсторонней очереди. Этот метод отличается от peekLast только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Возвраты:

хвост этой двухсторонней очереди

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

peekFirst

E peekFirst()

Получает, но не удаляет, первый элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.

Возвраты:

глава этой двухсторонней очереди, или null, если эта двухсторонняя очередь пуста

peekLast

E peekLast()

Получает, но не удаляет, последний элемент этой двухсторонней очереди, или возвращает null, если эта двухсторонняя очередь пуста.

Возвраты:

хвост этой двухсторонней очереди, или null, если эта двухсторонняя очередь пуста

removeFirstOccurrence

boolean removeFirstOccurrence(Object o)

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

Параметры:

o - элемент, который будет удален из этой двухсторонней очереди, если существующий

Возвраты:

true, если элемент был удален в результате этого вызова

Броски:

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

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

removeLastOccurrence

boolean removeLastOccurrence(Object o)

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

Параметры:

o - элемент, который будет удален из этой двухсторонней очереди, если существующий

Возвраты:

true, если элемент был удален в результате этого вызова

Броски:

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

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

добавить

boolean add(E e)

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

Этот метод эквивалентен addLast(E).

Определенный:

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

Определенный:

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

Параметры:

e - элемент, чтобы добавить

Возвраты:

true (как определено Collection.add(E))

Броски:

IllegalStateException - если элемент не может быть добавлен в это время из-за ограничений емкости

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

предложение

boolean offer(E e)

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

Этот метод эквивалентен offerLast(E).

Определенный:

offer в интерфейсе Queue<E>

Параметры:

e - элемент, чтобы добавить

Возвраты:

true, если элемент был добавлен к этой двухсторонней очереди, еще false

Броски:

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

удалить

E remove()

Получает и удаляет главу очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди). Этот метод отличается от poll только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Этот метод эквивалентен removeFirst().

Определенный:

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

Возвраты:

глава очереди представляется этой двухсторонней очередью

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

опрос

E poll()

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

Этот метод эквивалентен pollFirst().

Определенный:

poll в интерфейсе Queue<E>

Возвраты:

первый элемент этой двухсторонней очереди, или null, если эта двухсторонняя очередь пуста

элемент

E element()

Получает, но не удаляет, глава очереди, представленной этой двухсторонней очередью (другими словами, первый элемент этой двухсторонней очереди). Этот метод отличается от peek только в этом это выдает исключение, если эта двухсторонняя очередь пуста.

Этот метод эквивалентен getFirst().

Определенный:

element в интерфейсе Queue<E>

Возвраты:

глава очереди представляется этой двухсторонней очередью

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

быстрый взгляд

E peek()

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

Этот метод эквивалентен peekFirst().

Определенный:

peek в интерфейсе Queue<E>

Возвраты:

глава очереди, представленной этой двухсторонней очередью, или null, если эта двухсторонняя очередь пуста

продвинуть

void push(E e)

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

Этот метод эквивалентен addFirst(E).

Параметры:

e - элемент, чтобы продвинуть

Броски:

IllegalStateException - если элемент не может быть добавлен в это время из-за ограничений емкости

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

NullPointerException - если указанный элемент является нулем, и эта двухсторонняя очередь не разрешает нулевые элементы

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

появиться

E pop()

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

Этот метод эквивалентен removeFirst().

Возвраты:

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

Броски:

NoSuchElementException - если эта двухсторонняя очередь пуста

удалить

boolean remove(Object o)

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

Этот метод эквивалентен removeFirstOccurrence(java.lang.Object).

Определенный:

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

Параметры:

o - элемент, который будет удален из этой двухсторонней очереди, если существующий

Возвраты:

true, если элемент был удален в результате этого вызова

Броски:

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

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

содержит

boolean contains(Object o)

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

Определенный:

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

Параметры:

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

Возвраты:

true, если эта двухсторонняя очередь содержит указанный элемент

Броски:

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

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

размер

int size()

Возвращает число элементов в этой двухсторонней очереди.

Определенный:

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

Возвраты:

число элементов в этой двухсторонней очереди

iterator

Iterator<E> iterator()

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

Определенный:

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

Определенный:

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

Возвраты:

iterator по элементам в этой двухсторонней очереди в надлежащей последовательности

descendingIterator

Iterator<E> descendingIterator()

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

Возвраты:

iterator по элементам в этой двухсторонней очереди в обратной последовательности