--- projects/cms/source/util/uk/org/iscream/cms/util/Queue.java 2001/01/30 01:56:28 1.7 +++ 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.7 2001/01/30 01:56:28 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.7 $"; + 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. */ @@ -95,7 +96,7 @@ 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))) { @@ -150,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) { @@ -162,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; @@ -214,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(