com.dropbox.core

Class DbxDelta<MD extends Dumpable>

java.lang.Object

com.dropbox.core.util.Dumpable

com.dropbox.core.DbxDelta<MD>

Type Parameters:

MD - The type of metadata being returned in the delta results. For example, in the DbxClient.getDelta(java.lang.String), this has type DbxEntry.

public final class DbxDelta<MD extends Dumpable>
extends Dumpable

Represents a single "page" of results from a delta-style API call.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbxDelta.Entry<MD extends Dumpable> A single "delta entry" in a DbxDelta page.
static class	DbxDelta.Reader<MD extends Dumpable> For JSON parsing.

Field Summary

Fields

Modifier and Type	Field and Description
String	cursor A string that is used by the server to keep track of which entries have already been returned to you.
List<DbxDelta.Entry<MD>>	entries Apply these entries to your local state to catch up with the Dropbox server's state.
boolean	hasMore If true, then there are more entries available.
boolean	reset If true, then you should reset your local state to be an empty folder before processing the list of delta entries.

Constructor Summary

Constructors

Constructor and Description
DbxDelta(boolean reset, List<DbxDelta.Entry<MD>> entries, String cursor, boolean hasMore)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dumpFields(DumpWriter out)

Methods inherited from class com.dropbox.core.util.Dumpable

getTypeName, toString, toString, toStringMultiline, toStringMultiline

Methods inherited from class java.lang.Object

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

Field Detail

reset

public final boolean reset

If true, then you should reset your local state to be an empty folder before processing the list of delta entries.

This is always true for the first delta result, but for subsequent results it is true only in true rare situations. For example, if Dropbox changes their cursor format, or if a user asks Dropbox to completely reset his/her account, then the next time you call a delta API it may send down a reset and start you from scratch.

entries

public final List<DbxDelta.Entry<MD extends Dumpable>> entries

Apply these entries to your local state to catch up with the Dropbox server's state.

cursor

public final String cursor

A string that is used by the server to keep track of which entries have already been returned to you. This is what you pass in to the next API call to continue where you left off.

This cursor is valid for a long time. You'd typically store this somewhere persistent (such as a database) so you can resume continue you left off.

hasMore

public final boolean hasMore

If true, then there are more entries available. You can retrieve them immediately by making the call again (passing in cursor). If false, then wait at least 5 minutes before checking again.

Constructor Detail

DbxDelta

public DbxDelta(boolean reset,
        List<DbxDelta.Entry<MD>> entries,
        String cursor,
        boolean hasMore)

Parameters:

reset - reset

entries - entries

cursor - cursor

hasMore - hasMore

Method Detail

dumpFields

protected void dumpFields(DumpWriter out)

Specified by:

dumpFields in class Dumpable