FileDocCategorySizeDatePackage
CopyStreamListener.javaAPI DocApache Commons NET 1.4.1 API3060Sat Dec 03 10:05:48 GMT 2005org.apache.commons.net.io

CopyStreamListener

public interface CopyStreamListener implements 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
CopyStreamEvent
see
CopyStreamAdapter
see
Util
author
Daniel F. Savarese
version
$Id: CopyStreamListener.java 165675 2005-05-02 20:09:55Z rwinston $

Fields Summary
Constructors Summary
Methods Summary
public voidbytesTransferred(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.

param
event The CopyStreamEvent fired by the copying of a block of bytes.

public voidbytesTransferred(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.

param
totalBytesTransferred The total number of bytes transferred so far by the copy operation.
param
bytesTransferred The number of bytes copied by the most recent write.
param
streamSize The number of bytes in the stream being copied. This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if the size is unknown.