org.daisy.common.priority

Class WrappingPriorityQueue<T,K extends T>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<E>

com.google.common.collect.ForwardingQueue<E>

com.google.common.util.concurrent.ForwardingBlockingQueue<T>

org.daisy.common.priority.WrappingPriorityQueue<T,K>

All Implemented Interfaces:

Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>

public class WrappingPriorityQueue<T,K extends T>
extends com.google.common.util.concurrent.ForwardingBlockingQueue<T>

This class takes care of wrapping and unwrapping elements when they are added to the queue. The main restriction is that K has to be a subtype of T in order to be able to hide the actual to the forwarded queue.

Constructor Summary

Constructors

Constructor and Description
WrappingPriorityQueue(PriorityBlockingQueue<K> delegate, com.google.common.base.Function<T,K> wrapFunction, com.google.common.base.Function<K,T> unwrapFunction)

Method Summary

Modifier and Type	Method and Description
boolean	add(T e)
boolean	addAll(Collection<? extends T> collection)
boolean	addAllBypass(Collection<K> collection) Allows to add a set of elements that are already wrapped.
PriorityBlockingQueue<T>	delegate()
int	drainTo(Collection<? super T> c)
int	drainTo(Collection<? super T> c, int maxElements)
T	element()
Iterator<T>	iterator()
boolean	offer(T e)
boolean	offer(T e, long timeout, TimeUnit unit)
T	peek()
T	poll()
T	poll(long timeout, TimeUnit unit)
void	put(T e)
T	remove()
T	take()
Iterable<T>	unwrap() Returns an iterable with the unwrapped elements.
Iterable<K>	wrapped() Returns an iterable with the wrapped elements.

Methods inherited from class com.google.common.util.concurrent.ForwardingBlockingQueue

remainingCapacity

Methods inherited from class com.google.common.collect.ForwardingQueue

standardOffer, standardPeek, standardPoll

Methods inherited from class com.google.common.collect.ForwardingCollection

clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.BlockingQueue

contains, remove

Methods inherited from interface java.util.Collection

clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

WrappingPriorityQueue

public WrappingPriorityQueue(PriorityBlockingQueue<K> delegate,
                             com.google.common.base.Function<T,K> wrapFunction,
                             com.google.common.base.Function<K,T> unwrapFunction)

Parameters:

delegate -

Method Detail

delegate

public PriorityBlockingQueue<T> delegate()

Overrides:

delegate in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

unwrap

public Iterable<T> unwrap()

Returns an iterable with the unwrapped elements.

wrapped

public Iterable<K> wrapped()

Returns an iterable with the wrapped elements.

addAllBypass

public boolean addAllBypass(Collection<K> collection)

Allows to add a set of elements that are already wrapped. Useful when updating the queue.

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface BlockingQueue<T>

Specified by:

add in interface Queue<T>

Overrides:

add in class com.google.common.collect.ForwardingCollection<T>

offer

public boolean offer(T e)

Specified by:

offer in interface BlockingQueue<T>

Specified by:

offer in interface Queue<T>

Overrides:

offer in class com.google.common.collect.ForwardingQueue<T>

peek

public T peek()

Specified by:

peek in interface Queue<T>

Overrides:

peek in class com.google.common.collect.ForwardingQueue<T>

poll

public T poll()

Specified by:

poll in interface Queue<T>

Overrides:

poll in class com.google.common.collect.ForwardingQueue<T>

put

public void put(T e)

Specified by:

put in interface BlockingQueue<T>

Overrides:

put in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

take

public T take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<T>

Overrides:

take in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

Throws:

InterruptedException

offer

public boolean offer(T e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<T>

Overrides:

offer in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

Throws:

InterruptedException

drainTo

public int drainTo(Collection<? super T> c)

Specified by:

drainTo in interface BlockingQueue<T>

Overrides:

drainTo in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> c,
                   int maxElements)

Specified by:

drainTo in interface BlockingQueue<T>

Overrides:

drainTo in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

poll

public T poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BlockingQueue<T>

Overrides:

poll in class com.google.common.util.concurrent.ForwardingBlockingQueue<T>

Throws:

InterruptedException

addAll

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

Specified by:

addAll in interface Collection<T>

Overrides:

addAll in class com.google.common.collect.ForwardingCollection<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Overrides:

iterator in class com.google.common.collect.ForwardingCollection<T>

element

public T element()

Specified by:

element in interface Queue<T>

Overrides:

element in class com.google.common.collect.ForwardingQueue<T>

remove

public T remove()

Specified by:

remove in interface Queue<T>

Overrides:

remove in class com.google.common.collect.ForwardingQueue<T>