org.apache.commons.net.io

Class 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.

See Also:
CopyStreamListener, CopyStreamAdapter, Util

Field Summary

static long
UNKNOWN_STREAM_SIZE
Constant used to indicate the stream size is unknown.

Constructor Summary

CopyStreamEvent(Object source, long totalBytesTransferred, int bytesTransferred, long streamSize)
Creates a new CopyStreamEvent instance.

Method Summary

int
getBytesTransferred()
Returns the number of bytes transferred by the write that triggered the event.
long
getStreamSize()
Returns the size of the stream being copied.
long
getTotalBytesTransferred()
Returns the total number of bytes transferred so far by the copy operation.

Field Details

UNKNOWN_STREAM_SIZE

public static final long UNKNOWN_STREAM_SIZE
Constant used to indicate the stream size is unknown.
Field Value:
-1L

Constructor Details

CopyStreamEvent

public CopyStreamEvent(Object source,
                       long totalBytesTransferred,
                       int bytesTransferred,
                       long streamSize)
Creates a new CopyStreamEvent instance.
Parameters:
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.

Method Details

getBytesTransferred

public int getBytesTransferred()
Returns the number of bytes transferred by the write that triggered the event.
Returns:
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.
Returns:
The size of the stream being copied.

getTotalBytesTransferred

public long getTotalBytesTransferred()
Returns the total number of bytes transferred so far by the copy operation.
Returns:
The total number of bytes transferred so far by the copy operation.