Класс ArrayDeque<E>

Реализация интерфейса Deque с изменяемым массивом. Двусторонние очереди на основе массива не имеют ограничений по емкости; они растут по мере необходимости для поддержки использования. Они не потокобезопасны; при отсутствии внешней синхронизации они не поддерживают одновременный доступ нескольких потоков. Нулевые элементы запрещены. Этот класс, скорее всего, будет быстрее, чем Stack при использовании в качестве стека, и быстрее, чем LinkedList при использовании в качестве очереди.

Большинство ArrayDeque операций выполняются за амортизированное постоянное время. К исключениям относятся remove, removeFirstOccurrence, removeLastOccurrence, contains, iterator.remove() и операции над блоками, все из которых выполняются за линейное время.

Итераторы, возвращаемые методом iterator этого класса, являются быстродействующими: если двусторонняя очередь изменяется в любое время после создания итератора любым способом, кроме метода собственного итератора remove, итератор, как правило, выбросит исключение ConcurrentModificationException. Таким образом, при одновременном изменении итератор быстро и четко завершается, а не подвергает риску произвольное, непредсказуемое поведение в неопределенный момент времени в будущем.

Обратите внимание, что поведение быстродействующего итератора не гарантируется, так как, как правило, невозможно дать какие-либо жесткие гарантии при наличии неосинхронизированного одновременного изменения. Быстродействующие итераторы выбрасывают исключение ConcurrentModificationException по принципу наилучшего приближения. Поэтому неправильно писать программу, которая полагалась бы на это исключение для своей корректности: поведение быстродействующих итераторов следует использовать только для обнаружения ошибок.

Этот класс и его итератор реализуют все необязательные методы интерфейсов Collection и Iterator.

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

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

ArrayDeque

public ArrayDeque()

Создаёт пустой массивский дек с начальной ёмкостью, достаточной для хранения 16 элементов.

ArrayDeque

public ArrayDeque(int numElements)

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

Параметры:

numElements - нижняя граница начальной ёмкости дека

ArrayDeque

public ArrayDeque(Collection<? extends E> c)

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

Параметры:

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

Исключения:

NullPointerException - если указанная коллекция равна null

Методы

addFirst

public void addFirst(E e)

Вставляет указанный элемент в начало этого дека.

Унаследовано от:

addFirst в интерфейсе Deque<E>

Параметры:

e - добавляемый элемент

Исключения:

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

addLast

public void addLast(E e)

Унаследовано от:

addLast в интерфейсе Deque<E>

Параметры:

e - добавляемый элемент

Исключения:

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

offerFirst

public boolean offerFirst(E e)

Вставляет указанный элемент в начало этого дека.

Унаследовано от:

offerFirst в интерфейсе Deque<E>

Параметры:

e - добавляемый элемент

Возвращает:

true (как указано в Deque.offerFirst(E))

Исключения:

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

offerLast

public boolean offerLast(E e)

Вставляет указанный элемент в конец этого дека.

Унаследовано от:

offerLast в интерфейсе Deque<E>

Параметры:

e - добавляемый элемент

Возвращает:

true (как указано в Deque.offerLast(E))

Исключения:

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

removeFirst

public E removeFirst()

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

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

Унаследовано от:

removeFirst в интерфейсе Deque<E>

Возвращает:

начало этого дека

Исключения:

NoSuchElementException - если этот дек пуст

removeLast

public E removeLast()

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

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

Унаследовано от:

removeLast в интерфейсе Deque<E>

Возвращает:

хвост этого дека

Исключения:

NoSuchElementException - если этот дек пуст

pollFirst

public E pollFirst()

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

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

Унаследовано от:

pollFirst в интерфейсе Deque<E>

Возвращает:

начало этого дека или null , если этот дек пуст

pollLast

public E pollLast()

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

Возвращает и удаляет последний элемент этого дека или возвращает null , если этот дек пуст.

Унаследовано от:

pollLast в интерфейсе Deque<E>

Возвращает:

хвост этого дека или null , если этот дек пуст

getFirst

public E getFirst()

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

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

Унаследовано от:

getFirst в интерфейсе Deque<E>

Возвращает:

начало этого дека

Исключения:

NoSuchElementException - если этот дек пуст

getLast

public E getLast()

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

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

Унаследовано от:

getLast в интерфейсе Deque<E>

Возвращает:

хвост этого дека

Исключения:

NoSuchElementException - если этот дек пуст

peekFirst

public E peekFirst()

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

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

Унаследовано от:

peekFirst в интерфейсе Deque<E>

Возвращает:

начало этого дека или null , если этот дек пуст

peekLast

public E peekLast()

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

Возвращает, но не удаляет, последний элемент этого дека или возвращает null , если этот дек пуст.

Унаследовано от:

peekLast в интерфейсе Deque<E>

Возвращает:

хвост этого дека или null , если этот дек пуст

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

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

Унаследовано от:

removeFirstOccurrence в интерфейсе Deque<E>

Параметры:

o - элемент, подлежащий удалению из этого дека, если он присутствует

Возвращает:

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

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

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

Унаследовано от:

removeLastOccurrence в интерфейсе Deque<E>

Параметры:

o - элемент, подлежащий удалению из этого дека, если он присутствует

Возвращает:

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

add

public boolean add(E e)

Унаследовано от:

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

Унаследовано от:

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

Унаследовано от:

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

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

add в классе AbstractCollection<E>

Параметры:

e - добавляемый элемент

Возвращает:

true (как указано в Collection.add(E))

Исключения:

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

offer

public boolean offer(E e)

Унаследовано от:

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

Унаследовано от:

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

Параметры:

e - добавляемый элемент

Возвращает:

true (как указано в Queue.offer(E))

Исключения:

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

remove

public E remove()

Унаследовано от:

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

Унаследовано от:

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

Возвращает:

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

Исключения:

NoSuchElementException - если этот дек пуст

poll

public E poll()

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

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

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

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

Возвращает:

голову очереди, представленной этим деком, или null если этот дек пустой

element

public E element()

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

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

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

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

Возвращает:

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

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

NoSuchElementException - если этот дек пустой

peek

public E peek()

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

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

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

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

Возвращает:

голову очереди, представленной этим деком, или null если этот дек пустой

push

public void push(E e)

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

push в интерфейсе Deque<E>

Параметры:

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

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

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

pop

public E pop()

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

pop в интерфейсе Deque<E>

Возвращает:

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

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

NoSuchElementException - если этот дек пустой

size

public int size()

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

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

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

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

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

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

size в классе AbstractCollection<E>

Возвращает:

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

isEmpty

public boolean isEmpty()

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

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

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

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

isEmpty в классе AbstractCollection<E>

Возвращает:

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

iterator

public Iterator<E> iterator()

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

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

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

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

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

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

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

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

iterator в классе AbstractCollection<E>

Возвращает:

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

descendingIterator

public Iterator<E> descendingIterator()

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

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

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

descendingIterator в интерфейсе Deque<E>

Возвращает:

итератор по элементам в этом деке в обратном порядке

contains

public boolean contains(Object o)

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

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

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

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

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

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

contains в классе AbstractCollection<E>

Параметры:

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

Возвращает:

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

remove

public boolean remove(Object o)

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

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

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

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

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

remove в классе AbstractCollection<E>

Параметры:

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

Возвращает:

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

clear

public void clear()

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

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

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

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

clear в классе AbstractCollection<E>

toArray

public Object[] toArray()

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

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

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

toArray в классе AbstractCollection<E>

Возвращает:

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

toArray

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

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

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

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

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

toArray в классе AbstractCollection<E>

Параметры типа:

T - тип времени выполнения массива, который должен содержать коллекцию

Параметры:

a - массив, в который должны быть помещены элементы дека, если он достаточно большой; в противном случае для этой цели выделяется новый массив того же типа времени выполнения

Возвращает:

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

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

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

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

clone

public ArrayDeque<E> clone()

Возвращает копию этого дека.

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

clone в классе Object

Возвращает:

копию этого дека

См. также:

Cloneable

spliterator

public Spliterator<E> spliterator()

Указано в:

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

Указано в:

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

Возвращает:

итератор Spliterator по элементам в этом очереди с двойным концом

С тех пор, как:

1.8