Package com.oroinc.io
Class CopyStreamEvent
java.lang.Object
java.util.EventObject
com.oroinc.io.CopyStreamEvent
- All Implemented Interfaces:
Serializable
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.
- Author:
- Daniel F. Savarese
- See Also:
-
Field Summary
FieldsFields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorsConstructorDescriptionCopyStreamEvent
(Object source, long totalBytesTransferred, int bytesTransferred, long streamSize) Creates a new CopyStreamEvent instance. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of bytes transferred by the write that triggered the event.long
Returns the size of the stream being copied.long
Returns the total number of bytes transferred so far by the copy operation.Methods inherited from class java.util.EventObject
getSource, toString
-
Field Details
-
UNKNOWN_STREAM_SIZE
public static final long UNKNOWN_STREAM_SIZE- See Also:
-
-
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 toUNKNOWN_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.
-
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.
-
getStreamSize
public long getStreamSize()Returns the size of the stream being copied. This may be set toUNKNOWN_STREAM_SIZE
if the size is unknown.- Returns:
- The size of the stream being copied.
-