You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by el...@apache.org on 2008/06/06 14:52:13 UTC

svn commit: r663918 - /mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java

Author: elecharny
Date: Fri Jun  6 05:52:13 2008
New Revision: 663918

URL: http://svn.apache.org/viewvc?rev=663918&view=rev
Log:
Added some missing Javadoc, and some @inheritedDoc temporarilly

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java?rev=663918&r1=663917&r2=663918&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/WriteFuture.java Fri Jun  6 05:52:13 2008
@@ -69,11 +69,28 @@
      */
     void setException(Throwable cause);
 
+    /**
+     * Wait for the asynchronous operation to complete.
+     * The attached listeners will be notified when the operation is 
+     * completed.
+     * 
+     * @return the created {@link WriteFuture}
+     * @throws InterruptedException
+     */
     WriteFuture await() throws InterruptedException;
 
+    /**
+     * {@inheritDoc}
+     */
     WriteFuture awaitUninterruptibly();
 
+    /**
+     * {@inheritDoc}
+     */
     WriteFuture addListener(IoFutureListener<?> listener);
 
+    /**
+     * {@inheritDoc}
+     */
     WriteFuture removeListener(IoFutureListener<?> listener);
 }