Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Move PriorityQueue decorators to PriorityQueueUtils only 

(PriorityQueue interface has nothing to do with Buffer)


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131488 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-01-01 18:57:37 +00:00
parent b0ab65b742
commit a717f3a947
4 changed files with 127 additions and 328 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
src/java/org/apache/commons/collections/PriorityQueueUtils.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/Attic/PriorityQueueUtils.java,v 1.4 2003/12/03 14:39:42 scolebourne Exp $
* $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
@ -57,15 +57,13 @@
*/
package org.apache.commons.collections;
import org.apache.commons.collections.buffer.BinaryHeap;
import org.apache.commons.collections.buffer.SynchronizedPriorityQueue;
import org.apache.commons.collections.buffer.UnmodifiablePriorityQueue;
import java.util.NoSuchElementException;
/**
* Provides static utility methods and decorators for {@link PriorityQueue}.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2003/12/03 14:39:42 $
* @version $Revision: 1.5 $ $Date: 2004/01/01 18:57:37 $
*
* @author Stephen Colebourne
*/
@ -74,7 +72,7 @@ public class PriorityQueueUtils {
/**
* An empty unmodifiable priority queue.
*/
public static final PriorityQueue EMPTY_PRIORITY_QUEUE = UnmodifiablePriorityQueue.decorate(new BinaryHeap());
public static final PriorityQueue EMPTY_PRIORITY_QUEUE = new EmptyPriorityQueue();
/**
* <code>PriorityQueueUtils</code> should not normally be instantiated.
@ -91,7 +89,7 @@ public class PriorityQueueUtils {
* @throws IllegalArgumentException if the priority queue is null
*/
public static PriorityQueue synchronizedPriorityQueue(PriorityQueue priorityQueue) {
return SynchronizedPriorityQueue.decorate(priorityQueue);
return new SynchronizedPriorityQueue(priorityQueue);
}
/**
@ -102,7 +100,124 @@ public class PriorityQueueUtils {
* @throws IllegalArgumentException if the priority queue is null
*/
public static PriorityQueue unmodifiablePriorityQueue(PriorityQueue priorityQueue) {
return UnmodifiablePriorityQueue.decorate(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 "[]";
}
}
}

8
src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java
View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java,v 1.9 2003/11/29 17:26:21 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.10 2004/01/01 18:57:37 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,11 +64,11 @@ import java.util.NoSuchElementException;
* Provides synchronized wrapper methods for all the methods
* defined in the PriorityQueue interface.
*
* @deprecated Moved to buffer subpackage. Due to be removed in v4.0.
* @deprecated Use PriorityQueueUtils. Due to be removed in v4.0.
* @since Commons Collections 1.0
* @version $Revision: 1.9 $ $Date: 2003/11/29 17:26:21 $
* @version $Revision: 1.10 $ $Date: 2004/01/01 18:57:37 $
*
* @author <a href="mailto:ram.chidambaram@telus.com">Ram Chidambaram</a>
* @author Ram Chidambaram
*/
public final class SynchronizedPriorityQueue implements PriorityQueue {

155
src/java/org/apache/commons/collections/buffer/SynchronizedPriorityQueue.java
View File

@ -1,155 +0,0 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/Attic/SynchronizedPriorityQueue.java,v 1.1 2003/11/16 00:05:44 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.buffer;
import java.util.NoSuchElementException;
import org.apache.commons.collections.PriorityQueue;
/**
* <code>SynchronizedPriorityQueue</code> decorates another <code>PriorityQueue</code>
* to synchronize its behaviour for a multi-threaded environment.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:44 $
*
* @author <a href="mailto:ram.chidambaram@telus.com">Ram Chidambaram</a>
* @author Stephen Colebourne
*/
public class SynchronizedPriorityQueue implements PriorityQueue {
/** The priority queue to decorate */
protected final PriorityQueue priorityQueue;
/**
* Factory method to create a synchronized priority queue.
*
* @param priorityQueue the priority queue to decorate, must not be null
* @throws IllegalArgumentException if priority queue is null
*/
public static PriorityQueue decorate(PriorityQueue priorityQueue) {
return new SynchronizedPriorityQueue(priorityQueue);
}
/**
* Constructs a new synchronized priority queue.
*
* @param priorityQueue the priority queue to synchronize
*/
protected SynchronizedPriorityQueue(PriorityQueue priorityQueue) {
if (priorityQueue == null) {
throw new IllegalArgumentException("PriorityQueue must not be null");
}
this.priorityQueue = priorityQueue;
}
/**
* Clear all elements from queue.
*/
public synchronized void clear() {
priorityQueue.clear();
}
/**
* Test if queue is empty.
*
* @return true if queue is empty else false.
*/
public synchronized boolean isEmpty() {
return priorityQueue.isEmpty();
}
/**
* Insert an element into queue.
*
* @param element the element to be inserted
*/
public synchronized void insert(Object element) {
priorityQueue.insert(element);
}
/**
* Return element on top of heap but don't remove it.
*
* @return the element at top of heap
* @throws NoSuchElementException if isEmpty() == true
*/
public synchronized Object peek() throws NoSuchElementException {
return priorityQueue.peek();
}
/**
* Return element on top of heap and remove it.
*
* @return the element at top of heap
* @throws NoSuchElementException if isEmpty() == true
*/
public synchronized Object pop() throws NoSuchElementException {
return priorityQueue.pop();
}
/**
* Returns a string representation of the underlying queue.
*
* @return a string representation of the underlying queue
*/
public synchronized String toString() {
return priorityQueue.toString();
}
}

161
src/java/org/apache/commons/collections/buffer/UnmodifiablePriorityQueue.java
View File

@ -1,161 +0,0 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/Attic/UnmodifiablePriorityQueue.java,v 1.3 2003/12/03 12:27:36 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.buffer;
import java.util.NoSuchElementException;
import org.apache.commons.collections.PriorityQueue;
import org.apache.commons.collections.Unmodifiable;
/**
* <code>UnmodifiablePriorityQueue</code> decorates another <code>PriorityQueue</code>
* to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/03 12:27:36 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiablePriorityQueue implements PriorityQueue, Unmodifiable {
/** The priority queue to decorate */
protected final PriorityQueue priorityQueue;
/**
* Factory method to create an unmodifiable priority queue.
*
* @param priorityQueue the priority queue to decorate, must not be null
* @throws IllegalArgumentException if priority queue is null
*/
public static PriorityQueue decorate(PriorityQueue priorityQueue) {
if (priorityQueue instanceof Unmodifiable) {
return priorityQueue;
}
if (priorityQueue == null) {
throw new IllegalArgumentException("PriorityQueue must not be null");
}
return new UnmodifiablePriorityQueue(priorityQueue);
}
//-----------------------------------------------------------------------
/**
* Constructs a new synchronized priority queue.
*
* @param priorityQueue the priority queue to synchronize
*/
private UnmodifiablePriorityQueue(PriorityQueue priorityQueue) {
super();
this.priorityQueue = priorityQueue;
}
//-----------------------------------------------------------------------
/**
* Clear all elements from queue - Unsupported as unmodifiable.
*/
public synchronized void clear() {
throw new UnsupportedOperationException();
}
/**
* Test if queue is empty.
*
* @return true if queue is empty else false.
*/
public synchronized boolean isEmpty() {
return priorityQueue.isEmpty();
}
/**
* Insert an element into queue - Unsupported as unmodifiable.
*
* @param element the element to be inserted
*/
public synchronized void insert(Object element) {
throw new UnsupportedOperationException();
}
/**
* Return element on top of heap but don't remove it.
*
* @return the element at top of heap
* @throws NoSuchElementException if isEmpty() == true
*/
public synchronized Object peek() throws NoSuchElementException {
return priorityQueue.peek();
}
/**
* Return element on top of heap and remove it - Unsupported as unmodifiable.
*
* @return the element at top of heap
* @throws NoSuchElementException if isEmpty() == true
*/
public synchronized Object pop() throws NoSuchElementException {
throw new UnsupportedOperationException();
}
/**
* Returns a string representation of the underlying queue.
*
* @return a string representation of the underlying queue
*/
public synchronized String toString() {
return priorityQueue.toString();
}
}