You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/05/16 17:30:36 UTC
cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections PriorityQueueUtils.java SynchronizedPriorityQueue.java
scolebourne 2003/05/16 08:30:36
Modified: collections/src/java/org/apache/commons/collections
SynchronizedPriorityQueue.java
Added: collections/src/java/org/apache/commons/collections/decorators
SynchronizedPriorityQueue.java
UnmodifiablePriorityQueue.java
collections/src/java/org/apache/commons/collections
PriorityQueueUtils.java
Log:
Add PriorityQueueUtils and two decorators
Deprecate SynchronizedPriorityQueue in main package
Revision Changes Path
1.1 jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedPriorityQueue.java
Index: SynchronizedPriorityQueue.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/SynchronizedPriorityQueue.java,v 1.1 2003/05/16 15:30: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 acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments 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.decorators;
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/05/16 15:30:36 $
*
* @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();
}
}
1.1 jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiablePriorityQueue.java
Index: UnmodifiablePriorityQueue.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/decorators/UnmodifiablePriorityQueue.java,v 1.1 2003/05/16 15:30: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 acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments 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.decorators;
import java.util.NoSuchElementException;
import org.apache.commons.collections.PriorityQueue;
/**
* <code>UnmodifiablePriorityQueue</code> decorates another <code>PriorityQueue</code>
* to ensure it can't be altered.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/05/16 15:30:36 $
*
* @author Stephen Colebourne
*/
public class UnmodifiablePriorityQueue implements PriorityQueue {
/** 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) {
return new UnmodifiablePriorityQueue(priorityQueue);
}
/**
* Constructs a new synchronized priority queue.
*
* @param priorityQueue the priority queue to synchronize
*/
protected UnmodifiablePriorityQueue(PriorityQueue priorityQueue) {
if (priorityQueue == null) {
throw new IllegalArgumentException("PriorityQueue must not be null");
}
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();
}
}
1.7 +3 -2 jakarta-commons/collections/src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java
Index: SynchronizedPriorityQueue.java
===================================================================
RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/SynchronizedPriorityQueue.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SynchronizedPriorityQueue.java 16 May 2003 14:58:42 -0000 1.6
+++ SynchronizedPriorityQueue.java 16 May 2003 15:30:36 -0000 1.7
@@ -64,6 +64,7 @@
* Provides synchronized wrapper methods for all the methods
* defined in the PriorityQueue interface.
*
+ * @deprecated Moved to decorators subpackage. Due to be removed in v4.0.
* @since Commons Collections 1.0
* @version $Revision$ $Date$
*
1.1 jakarta-commons/collections/src/java/org/apache/commons/collections/PriorityQueueUtils.java
Index: PriorityQueueUtils.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/PriorityQueueUtils.java,v 1.1 2003/05/16 15:30: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 acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments 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 org.apache.commons.collections.decorators.SynchronizedPriorityQueue;
import org.apache.commons.collections.decorators.UnmodifiablePriorityQueue;
/**
* Provides static utility methods and decorators for {@link PriorityQueue}.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/05/16 15:30:36 $
*
* @author Stephen Colebourne
*/
public class PriorityQueueUtils {
/**
* An empty unmodifiable priority queue.
*/
public static final PriorityQueue EMPTY_PRIORITY_QUEUE = UnmodifiablePriorityQueue.decorate(new BinaryHeap());
/**
* <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 SynchronizedPriorityQueue.decorate(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 UnmodifiablePriorityQueue.decorate(priorityQueue);
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org