| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.commons.net.io.CopyStreamAdapter
public class CopyStreamAdapter
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 org.apache.commons.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.
CopyStreamEvent, 
CopyStreamListener, 
Util| Constructor Summary | |
|---|---|
| CopyStreamAdapter()Creates a new copyStreamAdapter. | |
| Method Summary | |
|---|---|
|  void | addCopyStreamListener(CopyStreamListener listener)Registers a CopyStreamListener to receive CopyStreamEvents. | 
|  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. | 
|  void | removeCopyStreamListener(CopyStreamListener listener)Unregisters a CopyStreamListener. | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public CopyStreamAdapter()
| Method Detail | 
|---|
public void bytesTransferred(CopyStreamEvent event)
bytesTransferred in interface CopyStreamListenerevent - The CopyStreamEvent fired by the copying of a block of
              bytes.
public void bytesTransferred(long totalBytesTransferred,
                             int bytesTransferred,
                             long streamSize)
bytesTransferred in interface CopyStreamListenertotalBytesTransferred - 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.public void addCopyStreamListener(CopyStreamListener listener)
listener - The CopyStreamlistener to register.public void removeCopyStreamListener(CopyStreamListener listener)
listener - The CopyStreamlistener to unregister.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||