com.dropbox.core

Class DbxEntry

java.lang.Object

com.dropbox.core.DbxDataObject

com.dropbox.core.DbxEntry

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DbxEntry.File, DbxEntry.Folder

public abstract class DbxEntry
extends DbxDataObject
implements Serializable

Holds the metadata for a Dropbox file system entry. Can either be a regular file or a folder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbxEntry.File The subclass of DbxEntry used to represent file metadata (as opposed to folder metadata).
static class	DbxEntry.Folder The subclass of DbxEntry used to represent folder metadata.
static class	DbxEntry.WithChildren Holds the metadata for a file or folder; if it's a folder, we also store the folder's hash and the metadata of its immediate children.
static class	DbxEntry.WithChildrenC<C> The more general case of DbxEntry.WithChildren.

Field Summary

Fields

Modifier and Type	Field and Description
String	iconName The name of the icon to use for this file.
boolean	mightHaveThumbnail Whether this file or folder might have a thumbnail image you can retrieve via the [TODO: thumbnail call].
String	name Just the last part of path.
String	path The path to the file or folder, relative to your application's root.
static JsonReader<DbxEntry>	Reader
static long	serialVersionUID

Method Summary

Methods

Modifier and Type	Method and Description
abstract DbxEntry.File	asFile() If this metadata entry is a file, return it as a DbxEntry.File instance.
abstract DbxEntry.Folder	asFolder() If this metadata entry is a folder, return it as a DbxEntry.Folder instance.
protected void	dumpFields(DumpWriter w)
static <C> DbxEntry.WithChildrenC<C>	extract(com.fasterxml.jackson.core.JsonParser parser, Collector<DbxEntry,? extends C> collector)
abstract boolean	isFile() Whether this metadata is for a file, which can be cast to type DbxEntry.File.
abstract boolean	isFolder() Whether this metadata is for a folder, which can be cast to type DbxEntry.Folder.

Methods inherited from class com.dropbox.core.DbxDataObject

dump, dump, dump, dump, dump, getTypeName, toStringDate, toStringMultiline, toStringMultiline

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

name

public final String name

Just the last part of path. Derived automatically from path.

See Also:

DbxPath.getName(java.lang.String)

path

public final String path

The path to the file or folder, relative to your application's root. The path always starts with a "/".

For full-Dropbox apps, the path is relative to the root of the user's Dropbox. For App Folder apps, the path is relative to your application's App Folder within the user's Dropbox.

iconName

public final String iconName

The name of the icon to use for this file. The set of names returned by this call match up with icons in a set of icons provided by Dropbox. Read more about the icon field in Dropbox's documentation for the /metadata HTTP endpoint.

mightHaveThumbnail

public final boolean mightHaveThumbnail

Whether this file or folder might have a thumbnail image you can retrieve via the [TODO: thumbnail call]. If this is true, there might be a thumbnail available. If this is false, there is definitely no thumbnail available.

Reader

public static final JsonReader<DbxEntry> Reader

Method Detail

dumpFields

protected void dumpFields(DumpWriter w)

Specified by:

dumpFields in class DbxDataObject

isFolder

public abstract boolean isFolder()

Whether this metadata is for a folder, which can be cast to type DbxEntry.Folder. (Every metadata object is either for a file or a folder.)

isFile

public abstract boolean isFile()

Whether this metadata is for a file, which can be cast to type DbxEntry.File. (Every metadata object is either for a file or a folder.)

asFolder

public abstract DbxEntry.Folder asFolder()

If this metadata entry is a folder, return it as a DbxEntry.Folder instance. If it's not a folder, return null.

asFile

public abstract DbxEntry.File asFile()

If this metadata entry is a file, return it as a DbxEntry.File instance. If it's not a file, return null.

extract

public static <C> DbxEntry.WithChildrenC<C> extract(com.fasterxml.jackson.core.JsonParser parser,
                                    Collector<DbxEntry,? extends C> collector)
                                         throws IOException,
                                                JsonReadException

Returns:

null if the entry is an 'is_deleted' entry.

Throws:

IOException

JsonReadException