--- experimental/server/Queue/Queue.java 2001/01/23 20:14:09 1.5 +++ experimental/server/Queue/Queue.java 2001/01/30 02:13:09 1.6 @@ -13,7 +13,7 @@ import uk.ac.ukc.iscream.util.*; * actually contains some elements. * * @author $Author: tdb $ - * @version $Id: Queue.java,v 1.5 2001/01/23 20:14:09 tdb Exp $ + * @version $Id: Queue.java,v 1.6 2001/01/30 02:13:09 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.5 $"; + public static final String REVISION = "$Revision: 1.6 $"; //---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. */ @@ -95,13 +96,27 @@ public class Queue { * shutdown() type methods that may have problems closing * if the thread of control is waiting on a queue. * - * @param queue the queue to release + * @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 @@ -136,6 +151,7 @@ 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) { @@ -148,7 +164,7 @@ public class Queue { * 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; @@ -200,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(