--- projects/cms/source/util/uk/org/iscream/cms/util/Queue.java	2001/01/18 19:13:57	1.4
+++ projects/cms/source/util/uk/org/iscream/cms/util/Queue.java	2001/01/30 02:12:23	1.8
@@ -13,7 +13,7 @@ import uk.ac.ukc.iscream.util.*;
  * actually contains some elements.
  *
  * @author  $Author: tdb $
- * @version $Id: Queue.java,v 1.4 2001/01/18 19:13:57 tdb Exp $
+ * @version $Id: Queue.java,v 1.8 2001/01/30 02:12:23 tdb Exp $
  */
 public class Queue {
 
@@ -22,7 +22,7 @@ public class Queue {
     /**
      * The current CVS revision of this class
      */
-    public static final String REVISION = "$Revision: 1.4 $";
+    public static final String REVISION = "$Revision: 1.8 $";
     
 //---STATIC METHODS---
 
@@ -62,6 +62,7 @@ public class Queue {
      * This method returns an object from the front of a given queue.
      * It will block until data exists in the queue if required.
      *
+     * @param The queue to retrieve data from.
      * @return The object from the front of the queue.
      * @throws InvalidQueueException if the queue does not exist.
      */
@@ -88,8 +89,36 @@ public class Queue {
         }
         return o;
     }
-       
+    
     /**
+     * This method releases a get() method that's currently
+     * waiting on an empty queue. This was designed for
+     * shutdown() type methods that may have problems closing
+     * if the thread of control is waiting on a queue.
+     *
+     * @param queue the queue to release.
+     */
+    public void releaseQueue(int queue) {
+        synchronized(((LinkedList) _lists.get(queue))) {
+                ((LinkedList) _lists.get(queue)).notifyAll();
+        }
+    }
+
+    /**
+     * This method erases the contents of a given queue. This
+     * method should be used with care. It can only empty one
+     * internal queue, not all of them. This must be called
+     * multiple times to empty all queues.
+     *
+     * @param queue the queue to empty.
+     */
+    public void clearQueue(int queue) {
+        synchronized(this) {
+            ((LinkedList) _lists.get(queue)).clear();
+        }
+    }
+    
+    /**
      * This method returns a textual status of the queues. It
      * is merely for observation, and would most likely be used
      * by a larger "monitoring" component. Information returned
@@ -122,22 +151,23 @@ public class Queue {
      *
      * @param queue The queue number to query.
      * @return the current size of the queue.
+     * @throws InvalidQueueException if the queue does not exist.
      */
     public int queueSize(int queue) throws InvalidQueueException {
-	if (queue >= _lists.size() || _lists.get(queue) == null) {
+        if (queue >= _lists.size() || _lists.get(queue) == null) {
             throw new InvalidQueueException("Requested queue "+queue+" does not exist");
         }
-	return ((LinkedList) _lists.get(queue)).size();
+        return ((LinkedList) _lists.get(queue)).size();
     }
     
     /**
      * Returns the total numer of elements to have passed
      * through this queue (ie. a counter on the add method).
      *
-     * @return the element-ometer
+     * @return the element-ometer.
      */
     public int elementCount() {
-	return _count;
+        return _count;
     }
     
     /**
@@ -186,7 +216,7 @@ public class Queue {
      * This uses the uk.ac.ukc.iscream.util.FormatName class
      * to format the toString()
      *
-     * @return the name of this class and its CVS revision
+     * @return the name of this class and its CVS revision.
      */
     public String toString() {
         return FormatName.getName(