CopyStreamListener
Date: 2016-06-23

org.apache.commons.net.io

## Interface CopyStreamListener

- All Superinterfaces:
    java.util.EventListener
  All Known Implementing Classes:
    CopyStreamAdapter

      public interface CopyStreamListener
      extends java.util.EventListener

  The CopyStreamListener class can accept CopyStreamEvents to keep track of the progress of a stream copying operation. However, it is currently not used that way within NetComponents for performance reasons. Rather the bytesTransferred(long, int) method is called directly rather than passing an event to bytesTransferred(CopyStreamEvent), saving the creation of a CopyStreamEvent instance. Also, the only place where CopyStreamListener is currently used within NetComponents is in the static methods of the uninstantiable org.apache.commons.io.Util class, which would preclude the use of addCopyStreamListener and removeCopyStreamListener methods. However, future additions may use the JavaBean event model, which is why the hooks have been included from the beginning.
  See Also:
    `CopyStreamEvent`, `CopyStreamAdapter`, `Util`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `bytesTransferred(CopyStreamEvent event)` This method is invoked by a CopyStreamEvent source after copying a block of bytes from a stream.
    `void` | `bytesTransferred(long totalBytesTransferred, int bytesTransferred, long streamSize)` This method is not part of the JavaBeans model and is used by the static methods in the org.apache.commons.io.Util class for efficiency.

- - ### Method Detail

    - #### bytesTransferred

          void bytesTransferred(CopyStreamEvent event)

      This method is invoked by a CopyStreamEvent source after copying a block of bytes from a stream. The CopyStreamEvent will contain the total number of bytes transferred so far and the number of bytes transferred in the last write.
      Parameters:
        `event` - The CopyStreamEvent fired by the copying of a block of bytes.

    - #### bytesTransferred

          void bytesTransferred(long totalBytesTransferred,
                              int bytesTransferred,
                              long streamSize)

      This method is not part of the JavaBeans model and is used by the static methods in the org.apache.commons.io.Util class for efficiency. It is invoked after a block of bytes to inform the listener of the transfer.
      Parameters:
        `totalBytesTransferred` - The total number of bytes transferred so far by the copy operation.
        `bytesTransferred` - The number of bytes copied by the most recent write.
        `streamSize` - The number of bytes in the stream being copied. This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if the size is unknown.