|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject org.apache.commons.net.io.CopyStreamEvent
public class CopyStreamEvent
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.
CopyStreamListener
,
CopyStreamAdapter
,
Util
,
Serialized FormField Summary | |
---|---|
static long |
UNKNOWN_STREAM_SIZE
Constant used to indicate the stream size is unknown. |
Fields inherited from class java.util.EventObject |
---|
source |
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. |
String |
toString()
|
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final long UNKNOWN_STREAM_SIZE
Constructor Detail |
---|
public CopyStreamEvent(Object source, long totalBytesTransferred, int bytesTransferred, long streamSize)
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 Detail |
---|
public int getBytesTransferred()
public long getTotalBytesTransferred()
public long getStreamSize()
UNKNOWN_STREAM_SIZE
if the
size is unknown.
public String toString()
toString
in class EventObject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |