Package com.oroinc.io
Class CopyStreamAdapter
java.lang.Object
com.oroinc.io.CopyStreamAdapter
- All Implemented Interfaces:
CopyStreamListener
,EventListener
The CopyStreamAdapter will relay CopyStreamEvents to a list of listeners
when either of its bytesTransferred() methods are called. Its purpose
is to facilitate the notification of the progress of a copy operation
performed by one of the static copyStream() methods in com.oroinc.io.Util
to multiple listeners. The static copyStream() methods invoke the
bytesTransfered(long, int) of a CopyStreamListener for performance
reasons and also because multiple listeners cannot be registered given
that the methods are static.
- Author:
- Daniel F. Savarese
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCopyStreamListener
(CopyStreamListener listener) Registers a CopyStreamListener to receive CopyStreamEvents.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 com.oroinc.io.Util class for efficiency.void
bytesTransferred
(CopyStreamEvent event) This method is invoked by a CopyStreamEvent source after copying a block of bytes from a stream.void
removeCopyStreamListener
(CopyStreamListener listener) Unregisters a CopyStreamListener.
-
Constructor Details
-
CopyStreamAdapter
public CopyStreamAdapter()Creates a new copyStreamAdapter.
-
-
Method Details
-
bytesTransferred
This method is invoked by a CopyStreamEvent source after copying a block of bytes from a stream. The CopyStreamEvent will contain the total number of bytes transferred so far and the number of bytes transferred in the last write. The CopyStreamAdapater will relay the event to all of its registered listeners, listing itself as the source of the event.- Specified by:
bytesTransferred
in interfaceCopyStreamListener
- Parameters:
event
- The CopyStreamEvent fired by the copying of a block of bytes.
-
bytesTransferred
public 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 com.oroinc.io.Util class for efficiency. It is invoked after a block of bytes to inform the listener of the transfer. The CopyStreamAdapater will create a CopyStreamEvent from the arguments and relay the event to all of its registered listeners, listing itself as the source of the event.- Specified by:
bytesTransferred
in interfaceCopyStreamListener
- Parameters:
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.
-
addCopyStreamListener
Registers a CopyStreamListener to receive CopyStreamEvents. Although this method is not declared to be synchronized, it is implemented in a thread safe manner.- Parameters:
listener
- The CopyStreamlistener to register.
-
removeCopyStreamListener
Unregisters a CopyStreamListener. Although this method is not synchronized, it is implemented in a thread safe manner.- Parameters:
listener
- The CopyStreamlistener to unregister.
-