]> source.dussan.org Git - vaadin-framework.git/commitdiff
fixed javadocs
authorMatti Tahvonen <matti.tahvonen@itmill.com>
Thu, 11 Nov 2010 09:49:50 +0000 (09:49 +0000)
committerMatti Tahvonen <matti.tahvonen@itmill.com>
Thu, 11 Nov 2010 09:49:50 +0000 (09:49 +0000)
svn changeset:15961/svn branch:6.5

src/com/vaadin/terminal/StreamVariable.java

index aeadaad61195f9c1e1da93f21d24da77e7033ff4..99eb2417efb6eb5343e39e6a1a4a905f4f41989d 100644 (file)
@@ -4,6 +4,9 @@ import java.io.OutputStream;
 import java.io.Serializable;
 
 import com.vaadin.Application;
+import com.vaadin.terminal.StreamVariable.StreamingEndedEvent;
+import com.vaadin.terminal.StreamVariable.StreamingFailedEvent;
+import com.vaadin.terminal.StreamVariable.StreamingStartedEvent;
 
 /**
  * StreamVariable is a special kind of variable whose value is streamed to an
@@ -45,9 +48,9 @@ public interface StreamVariable extends Serializable {
      * {@link #uploadStarted(StreamingStartedEvent)} event, but not after
      * reading each buffer.
      * 
-     * @return true if this ReceiverOwner wants to by notified during the upload
-     *         of the progress of streaming.
-     * @see ReceiverOwner#onProgress(int, int)
+     * @return true if this {@link StreamVariable} wants to by notified during
+     *         the upload of the progress of streaming.
+     * @see #onProgress(StreamingProgressedEvent)
      */
     boolean listenProgress();
 
@@ -69,8 +72,8 @@ public interface StreamVariable extends Serializable {
      * without the restriction.
      */
     /**
-     * ReceiverOwner can set this flag to true if it wants the Terminal to stop
-     * receiving current upload.
+     * If this method returns true while the content is being streamed the
+     * Terminal to stop receiving current upload.
      * <p>
      * Note, the usage of this method is not synchronized over the Application
      * instance by the terminal like other methods. The implementation should