com.dropbox.client2

Class ProgressListener

java.lang.Object

com.dropbox.client2.ProgressListener

Direct Known Subclasses:

ProgressListener.Adjusted

public abstract class ProgressListener
extends java.lang.Object

Receives file transfer progress updates for some API calls, e.g. getFile and putFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgressListener.Adjusted A progress listener that forwards on to another ProgressListener after adjusting the total and bytes.
static class	ProgressListener.ProgressHttpEntity A wrapper for an HttpEntity that can count the number of bytes transferred.

Constructor Summary

Constructors

Constructor and Description
ProgressListener()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	onProgress(long bytes, long total) Gets called when some bytes have been transferred since the last time it was called and the progress interval has passed.
long	progressInterval() Should return how often transferred bytes should be reported to this listener, in milliseconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressListener

public ProgressListener()

Method Detail

onProgress

public abstract void onProgress(long bytes,
              long total)

Gets called when some bytes have been transferred since the last time it was called and the progress interval has passed.

Parameters:

bytes - the number of bytes transferred.

total - the size of the file in bytes.

progressInterval

public long progressInterval()

Should return how often transferred bytes should be reported to this listener, in milliseconds. It is not guaranteed that updates will happen at this exact interval, but that at least this amount of time will pass between updates. The default implementation always returns 500 milliseconds.