Modifier and Type	Class and Description
pack-priv abstract class	AbstractLinkedDeque.AbstractLinkedIterator

Modifier and Type	Field and Description
pack-priv @Nullable E	first Pointer to first node.
pack-priv @Nullable E	last Pointer to last node.
pack-priv int	modCount The number of times this deque has been structurally modified.

Access	Constructor and Description
pack-priv	AbstractLinkedDeque()

Method Summary

Modifier and Type	Method and Description
public boolean	add(E the element to add e) Overrides java.util.AbstractCollection.add. Implements java.util.Deque.add, java.util.Collection.add. Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available.
public void	addFirst(E the element to add e) Implements java.util.Deque.addFirst. Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available.
public void	addLast(E the element to add e) Implements java.util.Deque.addLast. Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available.
pack-priv void	checkNotEmpty()
public void	clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Collection.clear. Removes all of the elements from this collection (optional operation).
public abstract boolean	contains(Object element whose presence in this deque is to be tested o) Redeclares java.util.Deque.contains, java.util.Collection.contains. Overrides java.util.AbstractCollection.contains. Returns `true` if this deque contains the specified element.
public LinkedDeque.PeekingIterator<E>	descendingIterator() Implements com.github.benmanes.caffeine.cache.LinkedDeque.descendingIterator. Returns an iterator over the elements in this deque in reverse sequential order.
public E	element() Implements java.util.Deque.element. Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque).
public E	getFirst() Implements java.util.Deque.getFirst. Retrieves, but does not remove, the first element of this deque.
public E	getLast() Implements java.util.Deque.getLast. Retrieves, but does not remove, the last element of this deque.
public boolean	isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Collection.isEmpty. Returns `true` if this collection contains no elements.
public boolean	isFirst(E the linked element e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.isFirst. Returns if the element is at the front of the deque.
public boolean	isLast(E the linked element e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.isLast. Returns if the element is at the back of the deque.
public LinkedDeque.PeekingIterator<E>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements com.github.benmanes.caffeine.cache.LinkedDeque.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this deque in proper sequence.
pack-priv void	linkFirst(final E the unlinked element e) Links the element to the front of the deque so that it becomes the first element.
pack-priv void	linkLast(final E the unlinked element e) Links the element to the back of the deque so that it becomes the last element.
public void	moveToBack(E the linked element e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToBack. Moves the element to the back of the deque so that it becomes the last element.
public void	moveToFront(E the linked element e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToFront. Moves the element to the front of the deque so that it becomes the first element.
public boolean	offer(E the element to add e) Implements java.util.Deque.offer. Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and `false` if no space is currently available.
public boolean	offerFirst(E the element to add e) Implements java.util.Deque.offerFirst. Inserts the specified element at the front of this deque unless it would violate capacity restrictions.
public boolean	offerLast(E the element to add e) Implements java.util.Deque.offerLast. Inserts the specified element at the end of this deque unless it would violate capacity restrictions.
public @Nullable E	peek() Implements java.util.Deque.peek. Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty.
public @Nullable E	peekFirst() Implements java.util.Deque.peekFirst. Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty.
public @Nullable E	peekLast() Implements java.util.Deque.peekLast. Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty.
public @Nullable E	poll() Implements java.util.Deque.poll. Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty.
public @Nullable E	pollFirst() Implements java.util.Deque.pollFirst. Retrieves and removes the first element of this deque, or returns `null` if this deque is empty.
public @Nullable E	pollLast() Implements java.util.Deque.pollLast. Retrieves and removes the last element of this deque, or returns `null` if this deque is empty.
public E	pop() Implements java.util.Deque.pop. Pops an element from the stack represented by this deque.
public void	push(E the element to push e) Implements java.util.Deque.push. Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available.
public E	remove() Implements java.util.Deque.remove. Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque).
public abstract boolean	remove(Object element to be removed from this deque, if present o) Redeclares java.util.Deque.remove, java.util.Collection.remove. Overrides java.util.AbstractCollection.remove. Removes the first occurrence of the specified element from this deque.
public boolean	removeAll(Collection<?> collection containing elements to be removed from this collection c) Overrides java.util.AbstractCollection.removeAll. Implements java.util.Collection.removeAll. Removes all of this collection's elements that are also contained in the specified collection (optional operation).
public E	removeFirst() Implements java.util.Deque.removeFirst. Retrieves and removes the first element of this deque.
public boolean	removeFirstOccurrence(Object element to be removed from this deque, if present o) Implements java.util.Deque.removeFirstOccurrence. Removes the first occurrence of the specified element from this deque.
public E	removeLast() Implements java.util.Deque.removeLast. Retrieves and removes the last element of this deque.
public boolean	removeLastOccurrence(Object element to be removed from this deque, if present o) Implements java.util.Deque.removeLastOccurrence. Removes the last occurrence of the specified element from this deque.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Deque.size, java.util.Collection.size. Returns the number of elements in this deque.
pack-priv void	unlink(E e) Unlinks the non-null element.
pack-priv E	unlinkFirst() Unlinks the non-null first element.
pack-priv E	unlinkLast() Unlinks the non-null last element.

Inherited from java.util.AbstractCollection:: addAll containsAll retainAll toArray toArray toString

Field Detail

first	back to summary
pack-priv @Nullable E first Pointer to first node. Invariant: (first == null && last == null) \|\| (first.prev == null)

last	back to summary
pack-priv @Nullable E last Pointer to last node. Invariant: (first == null && last == null) \|\| (last.next == null)

modCount	back to summary
pack-priv int modCount The number of times this deque has been structurally modified. Structural modifications are those that change the size of the deque, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.

Constructor Detail

AbstractLinkedDeque	back to summary
pack-priv AbstractLinkedDeque()

Method Detail

add back to summary

add	back to summary
public boolean add(E e) Overrides java.util.AbstractCollection.add. Implements java.util.Deque.add, java.util.Collection.add. Doc from java.util.Deque.add. Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and throwing an `IllegalStateException` if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use `offer`. This method is equivalent to `addLast`. Parameters e:E the element to add Returns:boolean `true` (as specified by `Collection#add`) Annotations @Override

public boolean add(E e)

Overrides java.util.AbstractCollection.add.

Implements java.util.Deque.add, java.util.Collection.add.

Doc from java.util.Deque.add.

Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use offer.

This method is equivalent to addLast.

Parameters

e:E: the element to add

Returns:boolean

true (as specified by Collection#add)

Annotations

@Override

addFirst back to summary

addFirst	back to summary
public void addFirst(E e) Implements java.util.Deque.addFirst. Doc from java.util.Deque.addFirst. Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use method `offerFirst`. Parameters e:E the element to add Annotations @Override

public void addFirst(E e)

Implements java.util.Deque.addFirst.

Doc from java.util.Deque.addFirst.

Inserts the specified element at the front of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use method offerFirst.

Parameters

e:E: the element to add

Annotations

@Override

addLast back to summary

addLast	back to summary
public void addLast(E e) Implements java.util.Deque.addLast. Doc from java.util.Deque.addLast. Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use method `offerLast`. This method is equivalent to `add`. Parameters e:E the element to add Annotations @Override

public void addLast(E e)

Implements java.util.Deque.addLast.

Doc from java.util.Deque.addLast.

Inserts the specified element at the end of this deque if it is possible to do so immediately without violating capacity restrictions, throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use method offerLast.

This method is equivalent to add.

Parameters

e:E: the element to add

Annotations

@Override

checkNotEmpty	back to summary
pack-priv void checkNotEmpty()

clear	back to summary
public void clear() Overrides java.util.AbstractCollection.clear. Implements java.util.Collection.clear. Doc from java.util.Collection.clear. Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns. Annotations @Override @SuppressWarnings:PMD.AvoidReassigningLoopVariables

clear

back to summary

public void clear()

Overrides java.util.AbstractCollection.clear.

Implements java.util.Collection.clear.

Doc from java.util.Collection.clear.

Removes all of the elements from this collection (optional operation). The collection will be empty after this method returns.

Annotations

@Override
@SuppressWarnings:PMD.AvoidReassigningLoopVariables

contains back to summary

contains	back to summary
public abstract boolean contains(Object o) Redeclares java.util.Deque.contains, java.util.Collection.contains. Overrides java.util.AbstractCollection.contains. Doc from java.util.Deque.contains. Returns `true` if this deque contains the specified element. More formally, returns `true` if and only if this deque contains at least one element `e` such that `Objects.equals(o, e)`. Parameters o:Object element whose presence in this deque is to be tested Returns:boolean `true` if this deque contains the specified element Annotations @Override

public abstract boolean contains(Object o)

Redeclares java.util.Deque.contains, java.util.Collection.contains.

Overrides java.util.AbstractCollection.contains.

Doc from java.util.Deque.contains.

Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that Objects.equals(o, e).

Parameters

o:Object: element whose presence in this deque is to be tested

Returns:boolean

true if this deque contains the specified element

Annotations

@Override

descendingIterator	back to summary
public LinkedDeque.PeekingIterator<E> descendingIterator() Implements com.github.benmanes.caffeine.cache.LinkedDeque.descendingIterator. Doc from java.util.Deque.descendingIterator. Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head). Returns:LinkedDeque.PeekingIterator<E> an iterator over the elements in this deque in reverse sequence Annotations @Override

descendingIterator

back to summary

public LinkedDeque.PeekingIterator<E> descendingIterator()

Implements com.github.benmanes.caffeine.cache.LinkedDeque.descendingIterator.

Doc from java.util.Deque.descendingIterator.

Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).

Returns:LinkedDeque.PeekingIterator<E>

an iterator over the elements in this deque in reverse sequence

Annotations

@Override

element back to summary

element	back to summary
public E element() Implements java.util.Deque.element. Doc from java.util.Deque.element. Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from `peek` only in that it throws an exception if this deque is empty. This method is equivalent to `getFirst()`. Returns:E the head of the queue represented by this deque Annotations @Override

public E element()

Implements java.util.Deque.element.

Doc from java.util.Deque.element.

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

This method is equivalent to getFirst().

Returns:E

the head of the queue represented by this deque

Annotations

@Override

getFirst back to summary

getFirst	back to summary
public E getFirst() Implements java.util.Deque.getFirst. Doc from java.util.Deque.getFirst. Retrieves, but does not remove, the first element of this deque. This method differs from `peekFirst` only in that it throws an exception if this deque is empty. Returns:E the head of this deque Annotations @Override @SuppressWarnings:NullAway

public E getFirst()

Implements java.util.Deque.getFirst.

Doc from java.util.Deque.getFirst.

Retrieves, but does not remove, the first element of this deque. This method differs from peekFirst only in that it throws an exception if this deque is empty.

Returns:E

the head of this deque

Annotations

@Override
@SuppressWarnings:NullAway

getLast back to summary

getLast	back to summary
public E getLast() Implements java.util.Deque.getLast. Doc from java.util.Deque.getLast. Retrieves, but does not remove, the last element of this deque. This method differs from `peekLast` only in that it throws an exception if this deque is empty. Returns:E the tail of this deque Annotations @Override @SuppressWarnings:NullAway

public E getLast()

Implements java.util.Deque.getLast.

Doc from java.util.Deque.getLast.

Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.

Returns:E

the tail of this deque

Annotations

@Override
@SuppressWarnings:NullAway

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Overrides java.util.AbstractCollection.isEmpty. Implements java.util.Collection.isEmpty. Doc from java.util.Collection.isEmpty. Returns `true` if this collection contains no elements. Returns:boolean `true` if this collection contains no elements Annotations @Override

public boolean isEmpty()

Overrides java.util.AbstractCollection.isEmpty.

Implements java.util.Collection.isEmpty.

Doc from java.util.Collection.isEmpty.

Returns true if this collection contains no elements.

Returns:boolean

true if this collection contains no elements

Annotations

@Override

isFirst	back to summary
public boolean isFirst(E e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.isFirst. Doc from com.github.benmanes.caffeine.cache.LinkedDeque.isFirst. Returns if the element is at the front of the deque. Parameters e:E the linked element Annotations @Override

isFirst

back to summary

public boolean isFirst(E e)

Implements com.github.benmanes.caffeine.cache.LinkedDeque.isFirst.

Doc from com.github.benmanes.caffeine.cache.LinkedDeque.isFirst.

Returns if the element is at the front of the deque.

Parameters

e:E: the linked element

Annotations

@Override

isLast	back to summary
public boolean isLast(E e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.isLast. Doc from com.github.benmanes.caffeine.cache.LinkedDeque.isLast. Returns if the element is at the back of the deque. Parameters e:E the linked element Annotations @Override

isLast

back to summary

public boolean isLast(E e)

Implements com.github.benmanes.caffeine.cache.LinkedDeque.isLast.

Doc from com.github.benmanes.caffeine.cache.LinkedDeque.isLast.

Returns if the element is at the back of the deque.

Parameters

e:E: the linked element

Annotations

@Override

iterator	back to summary
public LinkedDeque.PeekingIterator<E> iterator() Implements abstract java.util.AbstractCollection.iterator. Implements com.github.benmanes.caffeine.cache.LinkedDeque.iterator, java.util.Collection.iterator. Doc from java.util.Deque.iterator. Returns an iterator over the elements in this deque in proper sequence. The elements will be returned in order from first (head) to last (tail). Returns:LinkedDeque.PeekingIterator<E> an iterator over the elements in this deque in proper sequence Annotations @Override

iterator

back to summary

public LinkedDeque.PeekingIterator<E> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements com.github.benmanes.caffeine.cache.LinkedDeque.iterator, java.util.Collection.iterator.

Doc from java.util.Deque.iterator.

Returns an iterator over the elements in this deque in proper sequence. The elements will be returned in order from first (head) to last (tail).

Returns:LinkedDeque.PeekingIterator<E>

an iterator over the elements in this deque in proper sequence

Annotations

@Override

linkFirst	back to summary
pack-priv void linkFirst(final E e) Links the element to the front of the deque so that it becomes the first element. Parameters e:E the unlinked element

linkFirst

back to summary

pack-priv void linkFirst(final E e)

Links the element to the front of the deque so that it becomes the first element.

Parameters

e:E: the unlinked element

linkLast	back to summary
pack-priv void linkLast(final E e) Links the element to the back of the deque so that it becomes the last element. Parameters e:E the unlinked element

linkLast

back to summary

pack-priv void linkLast(final E e)

Links the element to the back of the deque so that it becomes the last element.

Parameters

e:E: the unlinked element

moveToBack	back to summary
public void moveToBack(E e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToBack. Doc from com.github.benmanes.caffeine.cache.LinkedDeque.moveToBack. Moves the element to the back of the deque so that it becomes the last element. Parameters e:E the linked element Annotations @Override

moveToBack

back to summary

public void moveToBack(E e)

Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToBack.

Doc from com.github.benmanes.caffeine.cache.LinkedDeque.moveToBack.

Moves the element to the back of the deque so that it becomes the last element.

Parameters

e:E: the linked element

Annotations

@Override

moveToFront	back to summary
public void moveToFront(E e) Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToFront. Doc from com.github.benmanes.caffeine.cache.LinkedDeque.moveToFront. Moves the element to the front of the deque so that it becomes the first element. Parameters e:E the linked element Annotations @Override

moveToFront

back to summary

public void moveToFront(E e)

Implements com.github.benmanes.caffeine.cache.LinkedDeque.moveToFront.

Doc from com.github.benmanes.caffeine.cache.LinkedDeque.moveToFront.

Moves the element to the front of the deque so that it becomes the first element.

Parameters

e:E: the linked element

Annotations

@Override

offer back to summary

offer	back to summary
public boolean offer(E e) Implements java.util.Deque.offer. Doc from java.util.Deque.offer. Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning `true` upon success and `false` if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the `add` method, which can fail to insert an element only by throwing an exception. This method is equivalent to `offerLast`. Parameters e:E the element to add Returns:boolean `true` if the element was added to this deque, else `false` Annotations @Override

public boolean offer(E e)

Implements java.util.Deque.offer.

Doc from java.util.Deque.offer.

Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the add method, which can fail to insert an element only by throwing an exception.

This method is equivalent to offerLast.

Parameters

e:E: the element to add

Returns:boolean

true if the element was added to this deque, else false

Annotations

@Override

offerFirst back to summary

offerFirst	back to summary
public boolean offerFirst(E e) Implements java.util.Deque.offerFirst. Doc from java.util.Deque.offerFirst. Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the `addFirst` method, which can fail to insert an element only by throwing an exception. Parameters e:E the element to add Returns:boolean `true` if the element was added to this deque, else `false` Annotations @Override

public boolean offerFirst(E e)

Implements java.util.Deque.offerFirst.

Doc from java.util.Deque.offerFirst.

Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addFirst method, which can fail to insert an element only by throwing an exception.

Parameters

e:E: the element to add

Returns:boolean

true if the element was added to this deque, else false

Annotations

@Override

offerLast back to summary

offerLast	back to summary
public boolean offerLast(E e) Implements java.util.Deque.offerLast. Doc from java.util.Deque.offerLast. Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the `addLast` method, which can fail to insert an element only by throwing an exception. Parameters e:E the element to add Returns:boolean `true` if the element was added to this deque, else `false` Annotations @Override

public boolean offerLast(E e)

Implements java.util.Deque.offerLast.

Doc from java.util.Deque.offerLast.

Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addLast method, which can fail to insert an element only by throwing an exception.

Parameters

e:E: the element to add

Returns:boolean

true if the element was added to this deque, else false

Annotations

@Override

peek back to summary

peek	back to summary
public @Nullable E peek() Implements java.util.Deque.peek. Doc from java.util.Deque.peek. Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. This method is equivalent to `peekFirst()`. Returns:@Nullable E the head of the queue represented by this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E peek()

Implements java.util.Deque.peek.

Doc from java.util.Deque.peek.

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.

This method is equivalent to peekFirst().

Returns:@Nullable E

the head of the queue represented by this deque, or null if this deque is empty

Annotations

@Override

peekFirst back to summary

peekFirst	back to summary
public @Nullable E peekFirst() Implements java.util.Deque.peekFirst. Doc from java.util.Deque.peekFirst. Retrieves, but does not remove, the first element of this deque, or returns `null` if this deque is empty. Returns:@Nullable E the head of this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E peekFirst()

Implements java.util.Deque.peekFirst.

Doc from java.util.Deque.peekFirst.

Retrieves, but does not remove, the first element of this deque, or returns null if this deque is empty.

Returns:@Nullable E

the head of this deque, or null if this deque is empty

Annotations

@Override

peekLast back to summary

peekLast	back to summary
public @Nullable E peekLast() Implements java.util.Deque.peekLast. Doc from java.util.Deque.peekLast. Retrieves, but does not remove, the last element of this deque, or returns `null` if this deque is empty. Returns:@Nullable E the tail of this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E peekLast()

Implements java.util.Deque.peekLast.

Doc from java.util.Deque.peekLast.

Retrieves, but does not remove, the last element of this deque, or returns null if this deque is empty.

Returns:@Nullable E

the tail of this deque, or null if this deque is empty

Annotations

@Override

poll back to summary

poll	back to summary
public @Nullable E poll() Implements java.util.Deque.poll. Doc from java.util.Deque.poll. Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns `null` if this deque is empty. This method is equivalent to `pollFirst()`. Returns:@Nullable E the first element of this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E poll()

Implements java.util.Deque.poll.

Doc from java.util.Deque.poll.

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns null if this deque is empty.

This method is equivalent to pollFirst().

Returns:@Nullable E

the first element of this deque, or null if this deque is empty

Annotations

@Override

pollFirst back to summary

pollFirst	back to summary
public @Nullable E pollFirst() Implements java.util.Deque.pollFirst. Doc from java.util.Deque.pollFirst. Retrieves and removes the first element of this deque, or returns `null` if this deque is empty. Returns:@Nullable E the head of this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E pollFirst()

Implements java.util.Deque.pollFirst.

Doc from java.util.Deque.pollFirst.

Retrieves and removes the first element of this deque, or returns null if this deque is empty.

Returns:@Nullable E

the head of this deque, or null if this deque is empty

Annotations

@Override

pollLast back to summary

pollLast	back to summary
public @Nullable E pollLast() Implements java.util.Deque.pollLast. Doc from java.util.Deque.pollLast. Retrieves and removes the last element of this deque, or returns `null` if this deque is empty. Returns:@Nullable E the tail of this deque, or `null` if this deque is empty Annotations @Override

public @Nullable E pollLast()

Implements java.util.Deque.pollLast.

Doc from java.util.Deque.pollLast.

Retrieves and removes the last element of this deque, or returns null if this deque is empty.

Returns:@Nullable E

the tail of this deque, or null if this deque is empty

Annotations

@Override

pop back to summary

pop	back to summary
public E pop() Implements java.util.Deque.pop. Doc from java.util.Deque.pop. Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque. This method is equivalent to `removeFirst()`. Returns:E the element at the front of this deque (which is the top of the stack represented by this deque) Annotations @Override

public E pop()

Implements java.util.Deque.pop.

Doc from java.util.Deque.pop.

Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.

This method is equivalent to removeFirst().

Returns:E

the element at the front of this deque (which is the top of the stack represented by this deque)

Annotations

@Override

push back to summary

push	back to summary
public void push(E e) Implements java.util.Deque.push. Doc from java.util.Deque.push. Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, throwing an `IllegalStateException` if no space is currently available. This method is equivalent to `addFirst`. Parameters e:E the element to push Annotations @Override

public void push(E e)

Implements java.util.Deque.push.

Doc from java.util.Deque.push.

Pushes an element onto the stack represented by this deque (in other words, at the head of this deque) if it is possible to do so immediately without violating capacity restrictions, throwing an IllegalStateException if no space is currently available.

This method is equivalent to addFirst.

Parameters

e:E: the element to push

Annotations

@Override

remove back to summary

remove	back to summary
public E remove() Implements java.util.Deque.remove. Doc from java.util.Deque.remove. Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from `poll()` only in that it throws an exception if this deque is empty. This method is equivalent to `removeFirst()`. Returns:E the head of the queue represented by this deque Annotations @Override

public E remove()

Implements java.util.Deque.remove.

Doc from java.util.Deque.remove.

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll() only in that it throws an exception if this deque is empty.

This method is equivalent to removeFirst().

Returns:E

the head of the queue represented by this deque

Annotations

@Override

remove back to summary

remove	back to summary
public abstract boolean remove(Object o) Redeclares java.util.Deque.remove, java.util.Collection.remove. Overrides java.util.AbstractCollection.remove. Doc from java.util.Deque.remove. Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element `e` such that `Objects.equals(o, e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). This method is equivalent to `removeFirstOccurrence(Object)`. Parameters o:Object element to be removed from this deque, if present Returns:boolean `true` if an element was removed as a result of this call Annotations @Override

public abstract boolean remove(Object o)

Redeclares java.util.Deque.remove, java.util.Collection.remove.

Overrides java.util.AbstractCollection.remove.

Doc from java.util.Deque.remove.

Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that Objects.equals(o, e) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

This method is equivalent to removeFirstOccurrence(Object).

Parameters

o:Object: element to be removed from this deque, if present

Returns:boolean

true if an element was removed as a result of this call

Annotations

@Override

removeAll back to summary

removeAll	back to summary
public boolean removeAll(Collection<?> c) Overrides java.util.AbstractCollection.removeAll. Implements java.util.Collection.removeAll. Doc from java.util.Collection.removeAll. Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection. Parameters c:Collection<?> collection containing elements to be removed from this collection Returns:boolean `true` if this collection changed as a result of the call Annotations @Override

public boolean removeAll(Collection<?> c)

Overrides java.util.AbstractCollection.removeAll.

Implements java.util.Collection.removeAll.

Doc from java.util.Collection.removeAll.

Removes all of this collection's elements that are also contained in the specified collection (optional operation). After this call returns, this collection will contain no elements in common with the specified collection.

Parameters

c:Collection<?>: collection containing elements to be removed from this collection

Returns:boolean

true if this collection changed as a result of the call

Annotations

@Override

removeFirst back to summary

removeFirst	back to summary
public E removeFirst() Implements java.util.Deque.removeFirst. Doc from java.util.Deque.removeFirst. Retrieves and removes the first element of this deque. This method differs from `pollFirst` only in that it throws an exception if this deque is empty. Returns:E the head of this deque Annotations @Override @SuppressWarnings:NullAway

public E removeFirst()

Implements java.util.Deque.removeFirst.

Doc from java.util.Deque.removeFirst.

Retrieves and removes the first element of this deque. This method differs from pollFirst only in that it throws an exception if this deque is empty.

Returns:E

the head of this deque

Annotations

@Override
@SuppressWarnings:NullAway

removeFirstOccurrence back to summary

removeFirstOccurrence	back to summary
public boolean removeFirstOccurrence(Object o) Implements java.util.Deque.removeFirstOccurrence. Doc from java.util.Deque.removeFirstOccurrence. Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element `e` such that `Objects.equals(o, e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). Parameters o:Object element to be removed from this deque, if present Returns:boolean `true` if an element was removed as a result of this call Annotations @Override

public boolean removeFirstOccurrence(Object o)

Implements java.util.Deque.removeFirstOccurrence.

Doc from java.util.Deque.removeFirstOccurrence.

Parameters

o:Object: element to be removed from this deque, if present

Returns:boolean

true if an element was removed as a result of this call

Annotations

@Override

removeLast back to summary

removeLast	back to summary
public E removeLast() Implements java.util.Deque.removeLast. Doc from java.util.Deque.removeLast. Retrieves and removes the last element of this deque. This method differs from `pollLast` only in that it throws an exception if this deque is empty. Returns:E the tail of this deque Annotations @Override @SuppressWarnings:NullAway

public E removeLast()

Implements java.util.Deque.removeLast.

Doc from java.util.Deque.removeLast.

Retrieves and removes the last element of this deque. This method differs from pollLast only in that it throws an exception if this deque is empty.

Returns:E

the tail of this deque

Annotations

@Override
@SuppressWarnings:NullAway

removeLastOccurrence back to summary

removeLastOccurrence	back to summary
public boolean removeLastOccurrence(Object o) Implements java.util.Deque.removeLastOccurrence. Doc from java.util.Deque.removeLastOccurrence. Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element `e` such that `Objects.equals(o, e)` (if such an element exists). Returns `true` if this deque contained the specified element (or equivalently, if this deque changed as a result of the call). Parameters o:Object element to be removed from this deque, if present Returns:boolean `true` if an element was removed as a result of this call Annotations @Override

public boolean removeLastOccurrence(Object o)

Implements java.util.Deque.removeLastOccurrence.

Doc from java.util.Deque.removeLastOccurrence.

Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that Objects.equals(o, e) (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

Parameters

o:Object: element to be removed from this deque, if present

Returns:boolean

true if an element was removed as a result of this call

Annotations

@Override

size	back to summary
public int size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Deque.size, java.util.Collection.size. Doc from java.util.Deque.size. Returns the number of elements in this deque. Beware that, unlike in most collections, this method is NOT a constant-time operation. Returns:int the number of elements in this deque Annotations @Override

size

back to summary

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Deque.size, java.util.Collection.size.

Doc from java.util.Deque.size.

Returns the number of elements in this deque.

Beware that, unlike in most collections, this method is NOT a constant-time operation.

Returns:int

the number of elements in this deque

Annotations

@Override

unlink	back to summary
pack-priv void unlink(E e) Unlinks the non-null element.

unlinkFirst	back to summary
pack-priv E unlinkFirst() Unlinks the non-null first element. Annotations @SuppressWarnings:NullAway

unlinkFirst

back to summary

pack-priv E unlinkFirst()

Unlinks the non-null first element.

Annotations

@SuppressWarnings:NullAway

unlinkLast	back to summary
pack-priv E unlinkLast() Unlinks the non-null last element. Annotations @SuppressWarnings:NullAway

unlinkLast

back to summary

pack-priv E unlinkLast()

Unlinks the non-null last element.

Annotations

@SuppressWarnings:NullAway

com.github.benmanes.caffeine.cache back to summary

pack-priv abstract Class AbstractLinkedDeque.AbstractLinkedIterator

Class Inheritance

extends Object
implements LinkedDeque.PeekingIterator<E>

java.lang.Object
com.github.benmanes.caffeine.cache.AbstractLinkedDeque.AbstractLinkedIterator

All Implemented Interfaces

com.github.benmanes.caffeine.cache.LinkedDeque.PeekingIterator, java.util.Iterator

Field Summary

Modifier and Type	Field and Description
pack-priv @Nullable E	cursor
pack-priv int	expectedModCount
pack-priv @Nullable E	previous

Constructor Summary

Access	Constructor and Description
pack-priv	AbstractLinkedIterator(@Nullable E the initial element to begin traversal from start) Creates an iterator that can can traverse the deque.

Method Summary

Modifier and Type	Method and Description
pack-priv void	checkForComodification() If the expected modCount value that the iterator believes that the backing deque should have is violated then the iterator has detected concurrent modification.
pack-priv abstract @Nullable E	computeNext() Retrieves the next element to traverse to or `null` if there are no more elements.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public E	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public @Nullable E	peek() Implements com.github.benmanes.caffeine.cache.LinkedDeque.PeekingIterator.peek. Returns the next element in the iteration, without advancing the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cursor	back to summary
pack-priv @Nullable E cursor

expectedModCount	back to summary
pack-priv int expectedModCount

previous	back to summary
pack-priv @Nullable E previous

Constructor Detail

AbstractLinkedIterator

back to summary

pack-priv AbstractLinkedIterator(@Nullable E start)

Creates an iterator that can can traverse the deque.

Parameters

start:@Nullable E: the initial element to begin traversal from

Method Detail

checkForComodification	back to summary
pack-priv void checkForComodification() If the expected modCount value that the iterator believes that the backing deque should have is violated then the iterator has detected concurrent modification.

computeNext	back to summary
pack-priv abstract @Nullable E computeNext() Retrieves the next element to traverse to or `null` if there are no more elements.

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

back to summary

public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations

@Override
@SuppressWarnings:NullAway

peek

back to summary

public @Nullable E peek()

Implements com.github.benmanes.caffeine.cache.LinkedDeque.PeekingIterator.peek.

Doc from com.github.benmanes.caffeine.cache.LinkedDeque.PeekingIterator.peek.

Returns the next element in the iteration, without advancing the iteration.

Annotations

@Override

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

pack-priv abstract Class AbstractLinkedDeque<E>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class AbstractLinkedDeque.AbstractLinkedIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail