Class AbstractLinkedDeque<E>

java.lang.Object

java.util.AbstractCollection<E>

com.github.benmanes.caffeine.cache.AbstractLinkedDeque<E>

Type Parameters:

E - the type of elements held in this collection

All Implemented Interfaces:

LinkedDeque<E>, Iterable<E>, Collection<E>, Deque<E>, Queue<E>, SequencedCollection<E>

Direct Known Subclasses:

AccessOrderDeque, WriteOrderDeque

abstract class AbstractLinkedDeque<E>
extends AbstractCollection<E>
implements LinkedDeque<E>

This class provides a skeletal implementation of the LinkedDeque interface to minimize the effort required to implement this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	AbstractLinkedDeque.AbstractLinkedIterator

Nested classes/interfaces inherited from interface LinkedDeque

LinkedDeque.PeekingIterator<E>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) @Nullable E	first	Pointer to first node.
(package private) @Nullable E	last	Pointer to last node.

Constructor Summary

Constructors

Constructor	Description
AbstractLinkedDeque()

Method Summary

Modifier and Type	Method	Description
boolean	add(E e)
void	addFirst(E e)
void	addLast(E e)
(package private) void	checkNotEmpty()
void	clear()
abstract boolean	contains(Object o)
LinkedDeque.PeekingIterator<E>	descendingIterator()
E	element()
E	getFirst()
E	getLast()
boolean	isEmpty()
boolean	isFirst(E e)	Returns if the element is at the front of the deque.
boolean	isLast(E e)	Returns if the element is at the back of the deque.
LinkedDeque.PeekingIterator<E>	iterator()
(package private) void	linkFirst(E e)	Links the element to the front of the deque so that it becomes the first element.
(package private) void	linkLast(E e)	Links the element to the back of the deque so that it becomes the last element.
void	moveToBack(E e)	Moves the element to the back of the deque so that it becomes the last element.
void	moveToFront(E e)	Moves the element to the front of the deque so that it becomes the first element.
boolean	offer(E e)
boolean	offerFirst(E e)
boolean	offerLast(E e)
@Nullable E	peek()
@Nullable E	peekFirst()
@Nullable E	peekLast()
@Nullable E	poll()
@Nullable E	pollFirst()
@Nullable E	pollLast()
E	pop()
void	push(E e)
E	remove()
boolean	removeAll(Collection<?> c)
E	removeFirst()
boolean	removeFirstOccurrence(Object o)
E	removeLast()
boolean	removeLastOccurrence(Object o)
int	size()
(package private) void	unlink(E e)	Unlinks the non-null element.
(package private) E	unlinkFirst()	Unlinks the non-null first element.
(package private) E	unlinkLast()	Unlinks the non-null last element.

Methods inherited from class AbstractCollection

addAll, containsAll, remove, retainAll, toArray, toArray, toString

Methods inherited from class Object

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

Methods inherited from interface Collection

containsAll, equals, hashCode, parallelStream, removeIf, retainAll, spliterator, stream, toArray, toArray, toArray

Methods inherited from interface Deque

addAll, remove, reversed

Methods inherited from interface Iterable

forEach

Methods inherited from interface LinkedDeque

getNext, getPrevious, setNext, setPrevious

Field Details

first

@Nullable E first

Pointer to first node. Invariant: (first == null invalid input: '&'invalid input: '&' last == null) || (first.prev == null)

last

@Nullable E last

Pointer to last node. Invariant: (first == null invalid input: '&'invalid input: '&' last == null) || (last.next == null)

Constructor Details

AbstractLinkedDeque

AbstractLinkedDeque()

Method Details

linkFirst

void linkFirst(E e)

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

Parameters:

e - the unlinked element

linkLast

void linkLast(E e)

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

Parameters:

e - the unlinked element

unlinkFirst

E unlinkFirst()

Unlinks the non-null first element.

unlinkLast

E unlinkLast()

Unlinks the non-null last element.

unlink

void unlink(E e)

Unlinks the non-null element.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Overrides:

isEmpty in class AbstractCollection<E>

checkNotEmpty

void checkNotEmpty()

size

public int size()

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

Specified by:

size in interface Collection<E>

Specified by:

size in interface Deque<E>

Specified by:

size in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollection<E>

contains

public abstract boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Deque<E>

Overrides:

contains in class AbstractCollection<E>

isFirst

public boolean isFirst(E e)

Description copied from interface: LinkedDeque

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

Specified by:

isFirst in interface LinkedDeque<E>

Parameters:

e - the linked element

isLast

public boolean isLast(E e)

Description copied from interface: LinkedDeque

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

Specified by:

isLast in interface LinkedDeque<E>

Parameters:

e - the linked element

moveToFront

public void moveToFront(E e)

Description copied from interface: LinkedDeque

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

Specified by:

moveToFront in interface LinkedDeque<E>

Parameters:

e - the linked element

moveToBack

public void moveToBack(E e)

Description copied from interface: LinkedDeque

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

Specified by:

moveToBack in interface LinkedDeque<E>

Parameters:

e - the linked element

peek

public @Nullable E peek()

Specified by:

peek in interface Deque<E>

Specified by:

peek in interface Queue<E>

peekFirst

public @Nullable E peekFirst()

Specified by:

peekFirst in interface Deque<E>

peekLast

public @Nullable E peekLast()

Specified by:

peekLast in interface Deque<E>

getFirst

public E getFirst()

Specified by:

getFirst in interface Deque<E>

Specified by:

getFirst in interface SequencedCollection<E>

getLast

public E getLast()

Specified by:

getLast in interface Deque<E>

Specified by:

getLast in interface SequencedCollection<E>

element

public E element()

Specified by:

element in interface Deque<E>

Specified by:

element in interface Queue<E>

offer

public boolean offer(E e)

Specified by:

offer in interface Deque<E>

Specified by:

offer in interface Queue<E>

offerFirst

public boolean offerFirst(E e)

Specified by:

offerFirst in interface Deque<E>

offerLast

public boolean offerLast(E e)

Specified by:

offerLast in interface Deque<E>

add

public boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Deque<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class AbstractCollection<E>

addFirst

public void addFirst(E e)

Specified by:

addFirst in interface Deque<E>

Specified by:

addFirst in interface SequencedCollection<E>

addLast

public void addLast(E e)

Specified by:

addLast in interface Deque<E>

Specified by:

addLast in interface SequencedCollection<E>

poll

public @Nullable E poll()

Specified by:

poll in interface Deque<E>

Specified by:

poll in interface Queue<E>

pollFirst

public @Nullable E pollFirst()

Specified by:

pollFirst in interface Deque<E>

pollLast

public @Nullable E pollLast()

Specified by:

pollLast in interface Deque<E>

remove

public E remove()

Specified by:

remove in interface Deque<E>

Specified by:

remove in interface Queue<E>

removeFirst

public E removeFirst()

Specified by:

removeFirst in interface Deque<E>

Specified by:

removeFirst in interface SequencedCollection<E>

removeFirstOccurrence

public boolean removeFirstOccurrence(Object o)

Specified by:

removeFirstOccurrence in interface Deque<E>

removeLast

public E removeLast()

Specified by:

removeLast in interface Deque<E>

Specified by:

removeLast in interface SequencedCollection<E>

removeLastOccurrence

public boolean removeLastOccurrence(Object o)

Specified by:

removeLastOccurrence in interface Deque<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollection<E>

push

public void push(E e)

Specified by:

push in interface Deque<E>

pop

public E pop()

Specified by:

pop in interface Deque<E>

iterator

public LinkedDeque.PeekingIterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Deque<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface LinkedDeque<E>

Specified by:

iterator in class AbstractCollection<E>

descendingIterator

public LinkedDeque.PeekingIterator<E> descendingIterator()

Specified by:

descendingIterator in interface Deque<E>

Specified by:

descendingIterator in interface LinkedDeque<E>