Package com.noleme.commons.container

Class EvictingQueue<T>

java.lang.Object

com.noleme.commons.container.EvictingQueue<T>

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>, Queue<T>

public final class EvictingQueue<T>
extends Object
implements Queue<T>, Serializable

Adaptation of Guava's EvictingQueue, without the ties to other Guava components.

Author:

Pierre LECERF ([email protected]) Created on 21/12/2019

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EvictingQueue(int maxSize)	Creates and returns a new evicting queue that will hold up to maxSize elements.

Method Summary

Modifier and Type	Method	Description
boolean	add(T e)	Adds the given element to this queue.
boolean	addAll(Collection<? extends T> collection)
void	clear()
boolean	contains(Object object)
boolean	containsAll(Collection<?> c)
protected Queue<T>	delegate()
T	element()
boolean	isEmpty()
Iterator<T>	iterator()
boolean	offer(T e)	Adds the given element to this queue.
T	peek()
T	poll()
int	remainingCapacity()	Returns the number of additional elements that this queue can accept without evicting; zero if the queue is currently full.
T	remove()
boolean	remove(Object object)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
Object[]	toArray()
<T1> T1[]	toArray(T1[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

EvictingQueue

public EvictingQueue(int maxSize)

Creates and returns a new evicting queue that will hold up to maxSize elements.

When maxSize is zero, elements will be evicted immediately after being added to the queue.

Parameters:

maxSize -

Method Details

remainingCapacity

public int remainingCapacity()

Returns the number of additional elements that this queue can accept without evicting; zero if the queue is currently full.

delegate

protected Queue<T> delegate()

offer

public boolean offer(T e)

Adds the given element to this queue. If the queue is currently full, the element at the head of the queue is evicted to make room.

Specified by:

offer in interface Queue<T>

Returns:

true always

remove

public T remove()

Specified by:

remove in interface Queue<T>

poll

public T poll()

Specified by:

poll in interface Queue<T>

element

public T element()

Specified by:

element in interface Queue<T>

peek

public T peek()

Specified by:

peek in interface Queue<T>

add

public boolean add(T e)

Adds the given element to this queue. If the queue is currently full, the element at the head of the queue is evicted to make room.

Specified by:

add in interface Collection<T>

Specified by:

add in interface Queue<T>

Returns:

true always

addAll

public boolean addAll(Collection<? extends T> collection)

Specified by:

addAll in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

size

public int size()

Specified by:

size in interface Collection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

contains

public boolean contains(Object object)

Specified by:

contains in interface Collection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

toArray

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

Specified by:

toArray in interface Collection<T>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>