com.codelanx.commons.util.cache

Class PackingQueue<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.AbstractSequentialList<E>

java.util.LinkedList<E>

com.codelanx.commons.util.cache.PackingQueue<E>

Type Parameters:

E - The type of objects in this queue

All Implemented Interfaces:

Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>

public class PackingQueue<E>
extends LinkedList<E>

Represents a queue which flushes all of its elements upon reaching a maximum size

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

See Also:

LinkedList, Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
PackingQueue(int maxSize, Consumer<E> onConsume) Initializes this PackingQueue for use
PackingQueue(int maxSize, Consumer<E> onConsume, boolean threaded) Initializes this PackingQueue for use

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
void	addFirst(E e)
void	addLast(E e)
void	flush() Flushes the contents of this PackingQueue and calls upon the Consumer passed in upon the construction of this queue.

Methods inherited from class java.util.LinkedList

add, addAll, addAll, clear, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, listIterator, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, set, size, spliterator, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, isEmpty, iterator, listIterator, removeAll, replaceAll, retainAll, sort, subList

Methods inherited from interface java.util.Deque

iterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PackingQueue

public PackingQueue(int maxSize,
                    Consumer<E> onConsume)

Initializes this PackingQueue for use

Parameters:

maxSize - The maximum size before flushing elements

onConsume - How to handle each element before removing it

See Also:

PackingQueue(int, Consumer, boolean)

PackingQueue

public PackingQueue(int maxSize,
                    Consumer<E> onConsume,
                    boolean threaded)

Initializes this PackingQueue for use

Parameters:

maxSize - The maximum size before flushing elements

onConsume - How to handle each element before removing it

threaded - true to execute the element flushing on another thread

Since:

0.1.0

Method Detail

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 List<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class LinkedList<E>

addFirst

public void addFirst(E e)

Specified by:

addFirst in interface Deque<E>

Overrides:

addFirst in class LinkedList<E>

addLast

public void addLast(E e)

Specified by:

addLast in interface Deque<E>

Overrides:

addLast in class LinkedList<E>

flush

public void flush()

Flushes the contents of this PackingQueue and calls upon the Consumer passed in upon the construction of this queue. This method is safe to call from multiple threads

Since:

0.1.0