io.realm

Class Progress

java.lang.Object

io.realm.Progress

public class Progress
extends Object

Class used to encapsulate progress notifications when either downloading or uploading Realm data. Each instance of this class is an immutable snapshot of the current progress.

If the ProgressListener was registered with ProgressMode.INDEFINITELY, the progress reported by getFractionTransferred() can both increase and decrease since more changes might be added while the progres listener is registered. This means it is possible for one notification to report true for isTransferComplete(), and then on the next event report false.

If the ProgressListener was registered with ProgressMode.CURRENT_CHANGES, progress can only ever increase, and once isTransferComplete() returns true, no further events will be generated.

See Also:

SyncSession.addDownloadProgressListener(ProgressMode, ProgressListener), SyncSession.addUploadProgressListener(ProgressMode, ProgressListener)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
double	getFractionTransferred() The fraction of bytes transferred out of all transferable bytes.
long	getTransferableBytes() Returns the total number of transferable bytes (bytes that have been transferred + bytes pending transfer).
long	getTransferredBytes() Returns the total number of bytes that has been transferred since the ProgressListener was added.
int	hashCode()
boolean	isTransferComplete() Returns true when all pending bytes have been transferred.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTransferredBytes

public long getTransferredBytes()

Returns the total number of bytes that has been transferred since the ProgressListener was added.

Returns:

the total number of bytes transferred since the ProgressListener was added.

getTransferableBytes

public long getTransferableBytes()

Returns the total number of transferable bytes (bytes that have been transferred + bytes pending transfer).

If the ProgressListener is tracking downloads, this number represents the size of the changesets generated by all other clients using the Realm.

If the ProgressListener is tracking uploads, this number represents the size of changesets created locally.

Returns:

the total number of bytes that has been transferred + number of bytes still pending transfer.

getFractionTransferred

public double getFractionTransferred()

The fraction of bytes transferred out of all transferable bytes. Counting from since the ProgressListener was added.

Returns:

a number between 0.0 and 1.0, where 0.0 represents that no data has been transferred yet, and 1.0 that all data has been transferred.

isTransferComplete

public boolean isTransferComplete()

Returns true when all pending bytes have been transferred.

If the ProgressListener was registered with ProgressMode.INDEFINITELY, this method can return false for subsequent events after returning true.

If the ProgressListener was registered with ProgressMode.CURRENT_CHANGES, when this method returns true, no more progress events will be sent.

Returns:

true if all changes have been transferred, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object