org.apache.commons.net.io
Class CopyStreamEvent
EventObject
org.apache.commons.net.io.CopyStreamEvent
public class CopyStreamEvent
extends EventObject
A CopyStreamEvent is triggered after every write performed by a
stream copying operation. The event stores the number of bytes
transferred by the write triggering the event as well as the total
number of bytes transferred so far by the copy operation.
$Id: CopyStreamEvent.java 165675 2005-05-02 20:09:55Z rwinston $
CopyStreamEvent(Object source, long totalBytesTransferred, int bytesTransferred, long streamSize) - Creates a new CopyStreamEvent instance.
|
UNKNOWN_STREAM_SIZE
public static final long UNKNOWN_STREAM_SIZE
Constant used to indicate the stream size is unknown.
CopyStreamEvent
public CopyStreamEvent(Object source,
long totalBytesTransferred,
int bytesTransferred,
long streamSize)
Creates a new CopyStreamEvent instance.
source
- The source of the event.totalBytesTransferred
- The total number of bytes transferred so
far during a copy operation.bytesTransferred
- The number of bytes transferred during the
write that triggered the CopyStreamEvent.streamSize
- The number of bytes in the stream being copied.
This may be set to UNKNOWN_STREAM_SIZE
if the
size is unknown.
getBytesTransferred
public int getBytesTransferred()
Returns the number of bytes transferred by the write that triggered
the event.
- The number of bytes transferred by the write that triggered
the vent.
getStreamSize
public long getStreamSize()
Returns the size of the stream being copied.
This may be set to UNKNOWN_STREAM_SIZE
if the
size is unknown.
- The size of the stream being copied.
getTotalBytesTransferred
public long getTotalBytesTransferred()
Returns the total number of bytes transferred so far by the copy
operation.
- The total number of bytes transferred so far by the copy
operation.