|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CopyStreamListener
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.
CopyStreamEvent
,
CopyStreamAdapter
,
Util
Method Summary | |
---|---|
void |
bytesTransferred(CopyStreamEvent event)
This method is invoked by a CopyStreamEvent source after copying a block of bytes from a stream. |
void |
bytesTransferred(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. |
Method Detail |
---|
void bytesTransferred(CopyStreamEvent event)
event
- The CopyStreamEvent fired by the copying of a block of
bytes.void bytesTransferred(long totalBytesTransferred, int bytesTransferred, long streamSize)
totalBytesTransferred
- The total number of bytes transferred
so far by the copy operation.bytesTransferred
- The number of bytes copied by the most recent
write.streamSize
- The number of bytes in the stream being copied.
This may be equal to CopyStreamEvent.UNKNOWN_STREAM_SIZE if
the size is unknown.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |