Deprecate PriorityQueue interface - Use Buffer interface instead

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131531 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/collections/BinaryHeap.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BinaryHeap.java,v 1.20 2004/01/05 22:46:33 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/BinaryHeap.java,v 1.21 2004/01/06 21:31:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -88,11 +88,13 @@ import java.util.NoSuchElementException;
  * to provide synchronized access to a <code>BinaryHeap</code>:
  *
  * <pre>
- * PriorityQueue heap = PriorityQueueUtils.synchronizedPriorityQueue(new BinaryHeap());
+ * PriorityQueue heap = new SynchronizedPriorityQueue(new BinaryHeap());
  * </pre>
  *
+ * @deprecated Replaced by PriorityBuffer in buffer subpackage.
+ *  Due to be removed in v4.0.
  * @since Commons Collections 1.0
- * @version $Revision: 1.20 $ $Date: 2004/01/05 22:46:33 $
+ * @version $Revision: 1.21 $ $Date: 2004/01/06 21:31:32 $
  * 
  * @author Peter Donald
  * @author Ram Chidambaram

src/java/org/apache/commons/collections/PriorityQueue.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/PriorityQueue.java,v 1.10 2004/01/05 22:46:33 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/PriorityQueue.java,v 1.11 2004/01/06 21:31:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -61,10 +61,11 @@ package org.apache.commons.collections;
  * Defines a collection for priority queues, which can insert, peek and pop.
  * <p>
  * This interface is now replaced by the <code>Buffer</code> interface.
- * It remains for backwards compatibility.
  *
+ * @deprecated Replaced by the Buffer interface and implementations in buffer subpackage.
+ *  Due to be removed in v4.0.
  * @since Commons Collections 1.0
- * @version $Revision: 1.10 $ $Date: 2004/01/05 22:46:33 $
+ * @version $Revision: 1.11 $ $Date: 2004/01/06 21:31:32 $
  * 
  * @author Peter Donald
  */

src/java/org/apache/commons/collections/PriorityQueueUtils.java

@@ -1,223 +0,0 @@
-/*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/PriorityQueueUtils.java,v 1.5 2004/01/01 18:57:37 scolebourne Exp $
- * ====================================================================
- *
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 2003 The Apache Software Foundation.  All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- *
- * 3. The end-user documentation included with the redistribution, if
- *    any, must include the following acknowledgement:
- *       "This product includes software developed by the
- *        Apache Software Foundation (http://www.apache.org/)."
- *    Alternately, this acknowledgement may appear in the software itself,
- *    if and wherever such third-party acknowledgements normally appear.
- *
- * 4. The names "The Jakarta Project", "Commons", and "Apache Software
- *    Foundation" must not be used to endorse or promote products derived
- *    from this software without prior written permission. For written
- *    permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache"
- *    nor may "Apache" appear in their names without prior written
- *    permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation.  For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- *
- */
-package org.apache.commons.collections;
-
-import java.util.NoSuchElementException;
-
-/**
- * Provides static utility methods and decorators for {@link PriorityQueue}.
- *
- * @since Commons Collections 3.0
- * @version $Revision: 1.5 $ $Date: 2004/01/01 18:57:37 $
- * 
- * @author Stephen Colebourne
- */
-public class PriorityQueueUtils {
-
-    /**
-     * An empty unmodifiable priority queue.
-     */
-    public static final PriorityQueue EMPTY_PRIORITY_QUEUE = new EmptyPriorityQueue();
-
-    /**
-     * <code>PriorityQueueUtils</code> should not normally be instantiated.
-     */
-    public PriorityQueueUtils() {
-    }
-
-    //-----------------------------------------------------------------------
-    /**
-     * Returns a synchronized priority queue backed by the given priority queue.
-     * 
-     * @param priorityQueue  the priority queue to synchronize, must not be null
-     * @return a synchronized priority queue backed by the given priority queue
-     * @throws IllegalArgumentException  if the priority queue is null
-     */
-    public static PriorityQueue synchronizedPriorityQueue(PriorityQueue priorityQueue) {
-        return new SynchronizedPriorityQueue(priorityQueue);
-    }
-
-    /**
-     * Returns an unmodifiable priority queue backed by the given priority queue.
-     *
-     * @param priorityQueue  the priority queue to make unmodifiable, must not be null
-     * @return an unmodifiable priority queue backed by the given priority queue
-     * @throws IllegalArgumentException  if the priority queue is null
-     */
-    public static PriorityQueue unmodifiablePriorityQueue(PriorityQueue priorityQueue) {
-        return new UnmodifiablePriorityQueue(priorityQueue);
-    }
-
-    //-----------------------------------------------------------------------
-    /**
-     * Decorator for PriorityQueue that adds synchronization.
-     */
-    static class SynchronizedPriorityQueue implements PriorityQueue {
-
-        /** The priority queue to decorate */
-        protected final PriorityQueue priorityQueue;
-
-        protected SynchronizedPriorityQueue(PriorityQueue priorityQueue) {
-            if (priorityQueue == null) {
-                throw new IllegalArgumentException("PriorityQueue must not be null");
-            }
-            this.priorityQueue = priorityQueue;
-        }
-
-        public synchronized boolean isEmpty() {
-            return priorityQueue.isEmpty();
-        }
-
-        public synchronized Object peek() {
-            return priorityQueue.peek();
-        }
-
-        public synchronized Object pop() {
-            return priorityQueue.pop();
-        }
-
-        public synchronized void insert(Object obj) {
-            priorityQueue.insert(obj);
-        }
-
-        public synchronized void clear() {
-            priorityQueue.clear();
-        }
-
-        public synchronized String toString() {
-            return priorityQueue.toString();
-        }
-    }
-    
-    //-----------------------------------------------------------------------
-    /**
-     * Decorator for PriorityQueue that prevents changes.
-     */
-    static class UnmodifiablePriorityQueue implements PriorityQueue, Unmodifiable {
-
-        /** The priority queue to decorate */
-        protected final PriorityQueue priorityQueue;
-
-        protected UnmodifiablePriorityQueue(PriorityQueue priorityQueue) {
-            if (priorityQueue == null) {
-                throw new IllegalArgumentException("PriorityQueue must not be null");
-            }
-            this.priorityQueue = priorityQueue;
-        }
-
-        public synchronized boolean isEmpty() {
-            return priorityQueue.isEmpty();
-        }
-
-        public synchronized Object peek() {
-            return priorityQueue.peek();
-        }
-
-        public synchronized Object pop() {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized void insert(Object obj) {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized void clear() {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized String toString() {
-            return priorityQueue.toString();
-        }
-    
-    }
-    
-    //-----------------------------------------------------------------------
-    /**
-     * PriorityQueue that is empty.
-     */
-    static class EmptyPriorityQueue implements PriorityQueue, Unmodifiable {
-
-        protected EmptyPriorityQueue() {
-        }
-
-        public synchronized boolean isEmpty() {
-            return true;
-        }
-
-        public synchronized Object peek() {
-            throw new NoSuchElementException();
-        }
-
-        public synchronized Object pop() {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized void insert(Object obj) {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized void clear() {
-            throw new UnsupportedOperationException();
-        }
-
-        public synchronized String toString() {
-            return "[]";
-        }
-    
-    }
-}

src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java

@@ -1,10 +1,10 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java,v 1.10 2004/01/01 18:57:37 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java,v 1.11 2004/01/06 21:31:32 scolebourne Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
  *
- * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
+ * Copyright (c) 2001-2004 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -64,9 +64,10 @@ import java.util.NoSuchElementException;
  * Provides synchronized wrapper methods for all the methods 
  * defined in the PriorityQueue interface.
  *
- * @deprecated Use PriorityQueueUtils. Due to be removed in v4.0.
+ * @deprecated PriorityQueue is replaced by the Buffer interface, see buffer subpackage.
+ *  Due to be removed in v4.0.
  * @since Commons Collections 1.0
- * @version $Revision: 1.10 $ $Date: 2004/01/01 18:57:37 $
+ * @version $Revision: 1.11 $ $Date: 2004/01/06 21:31:32 $
  * 
  * @author Ram Chidambaram
  */