com.carrotsearch.hppcrt

Interface ObjectDeque<KType>

All Superinterfaces:

java.lang.Iterable<ObjectCursor<KType>>, ObjectCollection<KType>, ObjectContainer<KType>

All Known Implementing Classes:

ObjectArrayDeque, ObjectLinkedList

@Generated(date="2017-07-11T19:16:23+0200",
           value="KTypeDeque.java")
public interface ObjectDeque<KType>
extends ObjectCollection<KType>

A double-sided queue of Objects.

Method Summary

Modifier and Type	Method and Description
void	addFirst(KType e1) Inserts the specified element at the front of this deque.
void	addLast(KType e1) Inserts the specified element at the end of this deque.
<T extends ObjectPredicate<? super KType>> T	descendingForEach(T predicate) Applies a predicate to container elements as long, as the predicate returns true.
<T extends ObjectProcedure<? super KType>> T	descendingForEach(T procedure) Applies a procedure to all container elements.
java.util.Iterator<ObjectCursor<KType>>	descendingIterator()
KType	getFirst() Retrieves, but does not remove, the first element of this deque.
KType	getLast() Retrieves, but does not remove, the last element of this deque.
KType	removeFirst() Retrieves and removes the first element of this deque.
int	removeFirst(KType e1) Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.
KType	removeLast() Retrieves and removes the last element of this deque.
int	removeLast(KType e1) Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.

Methods inherited from interface com.carrotsearch.hppcrt.ObjectCollection

clear, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppcrt.ObjectContainer

capacity, contains, forEach, forEach, isEmpty, iterator, size, toArray, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

removeFirst

int removeFirst(KType e1)

Removes the first element that equals e1, returning its deleted position or -1 if the element was not found.

removeLast

int removeLast(KType e1)

Removes the last element that equals e1, returning its deleted position or -1 if the element was not found.

addFirst

void addFirst(KType e1)

Inserts the specified element at the front of this deque.

Parameters:

e1 - the element to add

addLast

void addLast(KType e1)

Inserts the specified element at the end of this deque.

Parameters:

e1 - the element to add

removeFirst

KType removeFirst()

Retrieves and removes the first element of this deque. Precondition : the deque is not empty !

Returns:

the head element of this deque.

Throws:

java.lang.AssertionError - if this deque is empty and assertions are enabled.

removeLast

KType removeLast()

Retrieves and removes the last element of this deque. Precondition : the deque is not empty !

Returns:

the tail of this deque.

Throws:

java.lang.AssertionError - if this deque is empty and assertions are enabled.

getFirst

KType getFirst()

Retrieves, but does not remove, the first element of this deque. Precondition : the deque is not empty !

Returns:

the head of this deque.

Throws:

java.lang.AssertionError - if this deque is empty and assertions are enabled.

getLast

KType getLast()

Retrieves, but does not remove, the last element of this deque. Precondition : the deque is not empty !

Returns:

the tail of this deque.

Throws:

java.lang.AssertionError - if this deque is empty and assertions are enabled.

descendingIterator

java.util.Iterator<ObjectCursor<KType>> descendingIterator()

Returns:

An iterator over elements in this deque in tail-to-head order.

descendingForEach

<T extends ObjectProcedure<? super KType>> T descendingForEach(T procedure)

Applies a procedure to all container elements.

descendingForEach

<T extends ObjectPredicate<? super KType>> T descendingForEach(T predicate)

Applies a predicate to container elements as long, as the predicate returns true. The iteration is interrupted otherwise.