@Beta @GwtCompatible public final class EvictingQueue<E> extends ForwardingQueue<E> implements 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 | Method and Description |
|---|---|
boolean |
add(E e)
Adds the given element to this queue.
|
boolean |
addAll(Collection<? extends E> collection)
Adds all of the elements in the specified collection to this collection
(optional operation).
|
boolean |
contains(Object object)
Returns true if this collection contains the specified element.
|
static <E> EvictingQueue<E> |
create(int maxSize)
Creates and returns a new evicting queue that will hold up to
maxSize elements. |
protected 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.
|
boolean |
remove(Object object)
Removes a single instance of the specified element from this
collection, if it is present (optional operation).
|
element, peek, poll, remove, standardOffer, standardPeek, standardPollclear, containsAll, isEmpty, iterator, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArraytoStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitclear, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArraypublic 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 Queue<E> delegate()
ForwardingObjectForwardingSet.delegate(). Concrete subclasses override this method to supply the
instance being decorated.delegate in class ForwardingQueue<E>@CanIgnoreReturnValue public boolean offer(E e)
@CanIgnoreReturnValue public boolean add(E e)
add in interface Collection<E>add in interface Queue<E>add in class ForwardingCollection<E>e - element whose presence in this collection is to be ensuredtrue always@CanIgnoreReturnValue public boolean addAll(Collection<? extends E> collection)
java.util.CollectionaddAll in interface Collection<E>addAll in class ForwardingCollection<E>collection - collection containing elements to be added to this collectionCollection.add(Object)public boolean contains(Object object)
java.util.Collectioncontains in interface Collection<E>contains in class ForwardingCollection<E>object - element whose presence in this collection is to be tested@CanIgnoreReturnValue public boolean remove(Object object)
java.util.Collectionremove in interface Collection<E>remove in class ForwardingCollection<E>object - element to be removed from this collection, if presentCopyright © 2010–2020. All rights reserved.