commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject svn commit: r333047 - /jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
Date Sun, 13 Nov 2005 16:22:00 GMT
Author: scolebourne
Date: Sun Nov 13 08:21:57 2005
New Revision: 333047

URL: http://svn.apache.org/viewcvs?rev=333047&view=rev
Log:
Javadoc

Modified:
    jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java

Modified: jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java?rev=333047&r1=333046&r2=333047&view=diff
==============================================================================
--- jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
(original)
+++ jakarta/commons/proper/collections/trunk/src/java/org/apache/commons/collections/buffer/BlockingBuffer.java
Sun Nov 13 08:21:57 2005
@@ -89,6 +89,12 @@
         }
     }
 
+    /**
+     * Gets the next value from the buffer, waiting until an object is
+     * added if the buffer is empty.
+     *
+     * @throws BufferUnderflowException if an interrupt is received
+     */
     public Object get() {
         synchronized (lock) {
             while (collection.isEmpty()) {
@@ -104,6 +110,14 @@
         }
     }
 
+    /**
+     * Gets the next value from the buffer, waiting until an object is
+     * added for up to the specified timeout value if the buffer is empty.
+     *
+     * @param timeout  the timeout value in milliseconds
+     * @throws BufferUnderflowException if an interrupt is received
+     * @throws BufferUnderflowException if the timeout expires
+     */
     public Object get(final long timeout) {
         synchronized (lock) {
             final long expiration = System.currentTimeMillis() + timeout;
@@ -125,6 +139,12 @@
         }
     }
 
+    /**
+     * Removes the next value from the buffer, waiting until an object is
+     * added if the buffer is empty.
+     *
+     * @throws BufferUnderflowException if an interrupt is received
+     */
     public Object remove() {
         synchronized (lock) {
             while (collection.isEmpty()) {
@@ -140,6 +160,14 @@
         }
     }
 
+    /**
+     * Removes the next value from the buffer, waiting until an object is
+     * added for up to the specified timeout value if the buffer is empty.
+     *
+     * @param timeout  the timeout value in milliseconds
+     * @throws BufferUnderflowException if an interrupt is received
+     * @throws BufferUnderflowException if the timeout expires
+     */
     public Object remove(final long timeout) {
         synchronized (lock) {
             final long expiration = System.currentTimeMillis() + timeout;



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message