Package org.apache.qpid.protonj2.engine.util

Class RingQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractQueue<E>

org.apache.qpid.protonj2.engine.util.RingQueue<E>

Type Parameters:

E - the element type that is stored in this Queue type.

All Implemented Interfaces:

Iterable<E>, Collection<E>, Queue<E>

public class RingQueue<E>
extends AbstractQueue<E>

Simple Ring Queue implementation that has an enforced max size value.

Constructor Summary

Constructors

Constructor	Description
RingQueue(int queueSize)	Creates a new RingQueue instance with the given fixed Queue size.
RingQueue(Collection<E> collection)	Creates a new RingQueue instance with a size that matches the size of the given Collection and filled with the values from that Collection.

Method Summary

Modifier and Type	Method	Description
boolean	addAll(Collection<? extends E> c)
void	clear()
boolean	contains(Object value)
boolean	isEmpty()
Iterator<E>	iterator()
boolean	offer(E e)
E	peek()
E	poll()
E	poll(Supplier<E> createOnEmpty)	Retrieves and removes the head of this ring queue, and if the queue is currently empty a new instance of the queue type is provided by invoking the given Supplier.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()

Methods inherited from class java.util.AbstractQueue

add, element, remove

Methods inherited from class java.util.AbstractCollection

containsAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

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

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

RingQueue

public RingQueue(int queueSize)

Creates a new RingQueue instance with the given fixed Queue size.

Parameters:

queueSize - The size to use for the ring queue.

RingQueue

public RingQueue(Collection<E> collection)

Creates a new RingQueue instance with a size that matches the size of the given Collection and filled with the values from that Collection.

Parameters:

collection - the Collection whose values populates this RingQueue instance.

Method Details

offer

public boolean offer(E e)

poll

public E poll()

poll

public E poll(Supplier<E> createOnEmpty)

Retrieves and removes the head of this ring queue, and if the queue is currently empty a new instance of the queue type is provided by invoking the given Supplier.

Parameters:

createOnEmpty - a Supplier which will return default values if the RingQueue is empty.

Returns:

the head element of this queue or a default instance created from the provided Supplier/

peek

public E peek()

addAll

public boolean addAll(Collection<? extends E> c)

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractQueue<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollection<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in class AbstractCollection<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Overrides:

isEmpty in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractQueue<E>

contains

public boolean contains(Object value)

Specified by:

contains in interface Collection<E>

Overrides:

contains in class AbstractCollection<E>