org.daisy.common.priority.WrappingPriorityQueue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-utils Show documentation
The newest version!
package org.daisy.common.priority;

import java.util.Collection;
import java.util.Iterator;
import java.util.concurrent.PriorityBlockingQueue;
import java.util.concurrent.TimeUnit;

import com.google.common.base.Function;
import com.google.common.collect.Collections2;
import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.ForwardingBlockingQueue;
/**
 * 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.
 *
 */
public class WrappingPriorityQueue extends ForwardingBlockingQueue {

        private PriorityBlockingQueue delegate;
        private Function wrapFunction;
        private Function unwrapFunction;

        /**
         * @param delegate
         */
        public WrappingPriorityQueue(PriorityBlockingQueue delegate,Function wrapFunction,Function unwrapFunction ) {
                this.delegate = delegate;
                this.wrapFunction=wrapFunction;
                this.unwrapFunction=unwrapFunction;
        }

        @SuppressWarnings({ "unchecked" })//this never fails, it's just a view
        public PriorityBlockingQueue delegate(){
                return (PriorityBlockingQueue)this.delegate;
        }
        /**
         * Returns an iterable with the unwrapped elements.
         */
        public Iterable unwrap(){
                return Collections2.transform(this.delegate,unwrapFunction);
        }
        /**
         * Returns an iterable with the wrapped elements.
         */

        public Iterable wrapped(){
                return this.delegate;
        }

        /**
         * Convinience method
         */
        private K wrap( T element ){
                return this.wrapFunction.apply(element);
        }

        /**
         * Convinience method
         */
        private T unwrap( K element ){
                return this.unwrapFunction.apply(element);
        }

        /**
         * Allows to add a set of elements that are already 
         * wrapped. Useful when updating the queue.
         */
        public boolean addAllBypass(Collection collection) {
                return this.delegate.addAll(collection);
        }

        @Override
        public boolean add(T e) {
                return this.delegate.add(this.wrap(e));
        }

        @Override
        public boolean offer(T e) {
                return this.delegate.offer(this.wrap(e));
        }

        @Override
        public T peek() {
                return this.unwrap(this.delegate.peek());
        }

        @Override
        public T poll() {
                return this.unwrap(this.delegate.poll());
        }

        @Override
        public void put(T e) {
                this.delegate.put(this.wrap(e));
        }

        @Override
        public T take() throws InterruptedException {
                return this.unwrap(this.delegate.take());
        }

        @Override
        public boolean offer(T e, long timeout, TimeUnit unit)
                        throws InterruptedException {
                return this.delegate.offer(this.wrap(e), timeout, unit);
        }

        @Override
        public int drainTo(Collection c) {
                int size=this.delegate.size();
                c.addAll(Collections2.transform(this.delegate,this.unwrapFunction));
                this.delegate.clear();
                return size;

        }

        @Override
        public int drainTo(Collection c, int maxElements) {
                int i=0;
                while(i0){
                        c.add(this.poll());
                }
                return i;
        }

        @Override
        public T poll(long timeout, TimeUnit unit) throws InterruptedException {
                return this.unwrap(this.delegate.poll(timeout, unit));
        }

        @Override
        public boolean addAll(Collection collection) {
                for(T t:collection){
                        this.delegate.add(this.wrap(t));
                }
                return true;
        }


        @Override
        public Iterator iterator() {
                return Iterables.transform(this.delegate,this.unwrapFunction).iterator();
        }

        @Override
        public T element() {
                return this.unwrap(this.delegate.element());
        }

        @Override
        public T remove() {
                return this.unwrap(this.delegate.remove());
        }


}