public final class EvictingQueue<E> extends ForwardingQueue<E> implements java.io.Serializable
An evicting queue must be configured with a maximum size. Each time an element is added to a full queue, the queue automatically removes its head element. This is different from conventional bounded queues, which either block or reject new elements when full.
This class is not thread-safe, and does not accept null elements.
| Modifier and Type | Field and Description |
|---|---|
private java.util.Queue<E> |
delegate |
(package private) int |
maxSize |
private static long |
serialVersionUID |
| Modifier | Constructor and Description |
|---|---|
private |
EvictingQueue(int maxSize) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(E e)
Adds the given element to this queue.
|
boolean |
addAll(java.util.Collection<? extends E> collection) |
static <E> EvictingQueue<E> |
create(int maxSize)
Creates and returns a new evicting queue that will hold up to
maxSize elements. |
protected java.util.Queue<E> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
boolean |
offer(E e)
Adds the given element to this queue.
|
int |
remainingCapacity()
Returns the number of additional elements that this queue can accept without evicting; zero if
the queue is currently full.
|
java.lang.Object[] |
toArray() |
element, peek, poll, remove, standardOffer, standardPeek, standardPollclear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArraytoStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitprivate final java.util.Queue<E> delegate
final int maxSize
private static final long serialVersionUID
public static <E> EvictingQueue<E> create(int maxSize)
maxSize elements.
When maxSize is zero, elements will be evicted immediately after being added to the
queue.
public int remainingCapacity()
protected java.util.Queue<E> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply the
instance being decorated.delegate in class ForwardingQueue<E>public boolean offer(E e)
offer in interface java.util.Queue<E>offer in class ForwardingQueue<E>true alwayspublic boolean add(E e)
add in interface java.util.Collection<E>add in interface java.util.Queue<E>add in class ForwardingCollection<E>true alwayspublic boolean addAll(java.util.Collection<? extends E> collection)
addAll in interface java.util.Collection<E>addAll in class ForwardingCollection<E>public java.lang.Object[] toArray()
toArray in interface java.util.Collection<E>toArray in class ForwardingCollection<E>