svn commit: r1616695 - /commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java

[se...@apache.org]

Author: sebb
Date: Fri Aug  8 09:00:17 2014
New Revision: 1616695

URL: http://svn.apache.org/r1616695
Log:
Javadoc

Modified:
    commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java

Modified: commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java
URL: http://svn.apache.org/viewvc/commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java?rev=1616695&r1=1616694&r2=1616695&view=diff
==============================================================================
--- commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java (original)
+++ commons/proper/net/trunk/src/main/java/org/apache/commons/net/io/Util.java Fri Aug  8 09:00:17 2014
@@ -70,6 +70,7 @@ public final class Util
      *            A zero or negative value means to use {@link #DEFAULT_COPY_BUFFER_SIZE}.
      * @param streamSize  The number of bytes in the stream being copied.
      *          Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
+     * Not currently used (though it is passed to {@link CopyStreamListener#bytesTransferred(long, int, long)}
      * @param listener  The CopyStreamListener to notify of progress.  If
      *      this parameter is null, notification is not attempted.
      * @param flush Whether to flush the output stream after every
@@ -161,6 +162,7 @@ public final class Util
      *            A zero or negative value means to use {@link #DEFAULT_COPY_BUFFER_SIZE}.
      * @param streamSize  The number of bytes in the stream being copied.
      *          Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
+     * Not currently used (though it is passed to {@link CopyStreamListener#bytesTransferred(long, int, long)}
      * @param listener  The CopyStreamListener to notify of progress.  If
      *      this parameter is null, notification is not attempted.
      * @return number of bytes read/written
@@ -248,6 +250,7 @@ public final class Util
      *            A zero or negative value means to use {@link #DEFAULT_COPY_BUFFER_SIZE}.
      * @param streamSize  The number of characters in the stream being copied.
      *          Should be set to CopyStreamEvent.UNKNOWN_STREAM_SIZE if unknown.
+     * Not currently used (though it is passed to {@link CopyStreamListener#bytesTransferred(long, int, long)}
      * @param listener  The CopyStreamListener to notify of progress.  If
      *      this parameter is null, notification is not attempted.
      * @return  The number of characters read/written in the copy operation.