com.dropbox.core.v2.files

Class FileMetadata

java.lang.Object

com.dropbox.core.v2.files.Metadata

com.dropbox.core.v2.files.FileMetadata

public class FileMetadata
extends Metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileMetadata.Builder Builder for FileMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Date	clientModified
protected java.lang.String	contentHash
protected ExportInfo	exportInfo
protected FileLockMetadata	fileLockInfo
protected java.lang.Boolean	hasExplicitSharedMembers
protected java.lang.String	id
protected boolean	isDownloadable
protected MediaInfo	mediaInfo
protected java.util.List<PropertyGroup>	propertyGroups
protected java.lang.String	rev
protected java.util.Date	serverModified
protected FileSharingInfo	sharingInfo
protected long	size
protected SymlinkInfo	symlinkInfo

Fields inherited from class com.dropbox.core.v2.files.Metadata

name, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Constructor and Description
FileMetadata(java.lang.String name, java.lang.String id, java.util.Date clientModified, java.util.Date serverModified, java.lang.String rev, long size) None
FileMetadata(java.lang.String name, java.lang.String id, java.util.Date clientModified, java.util.Date serverModified, java.lang.String rev, long size, java.lang.String pathLower, java.lang.String pathDisplay, java.lang.String parentSharedFolderId, MediaInfo mediaInfo, SymlinkInfo symlinkInfo, FileSharingInfo sharingInfo, boolean isDownloadable, ExportInfo exportInfo, java.util.List<PropertyGroup> propertyGroups, java.lang.Boolean hasExplicitSharedMembers, java.lang.String contentHash, FileLockMetadata fileLockInfo) Use newBuilder to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Date	getClientModified() For files, this is the modification time set by the desktop client when the file was added to Dropbox.
java.lang.String	getContentHash() A hash of the file content.
ExportInfo	getExportInfo() Information about format this file can be exported to.
FileLockMetadata	getFileLockInfo() If present, the metadata associated with the file's current lock.
java.lang.Boolean	getHasExplicitSharedMembers() This flag will only be present if include_has_explicit_shared_members is true in DbxUserFilesRequests.listFolder(String) or DbxUserFilesRequests.getMetadata(String).
java.lang.String	getId() A unique identifier for the file.
boolean	getIsDownloadable() If true, file can be downloaded directly; else the file must be exported.
MediaInfo	getMediaInfo() Additional information if the file is a photo or video.
java.lang.String	getName() The last component of the path (including extension).
java.lang.String	getParentSharedFolderId() Please use FileSharingInfo.getParentSharedFolderId() or FolderSharingInfo.getParentSharedFolderId() instead.
java.lang.String	getPathDisplay() The cased path to be used for display purposes only.
java.lang.String	getPathLower() The lowercased full path in the user's Dropbox.
java.util.List<PropertyGroup>	getPropertyGroups() Additional information if the file has custom properties with the property template specified.
java.lang.String	getRev() A unique identifier for the current revision of a file.
java.util.Date	getServerModified() The last time the file was modified on Dropbox.
FileSharingInfo	getSharingInfo() Set if this file is contained in a shared folder.
long	getSize() The file size in bytes.
SymlinkInfo	getSymlinkInfo() Set if this file is a symlink.
int	hashCode()
static FileMetadata.Builder	newBuilder(java.lang.String name, java.lang.String id, java.util.Date clientModified, java.util.Date serverModified, java.lang.String rev, long size) Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.String	toStringMultiline() Returns a String representation of this object formatted for easier readability.

Methods inherited from class com.dropbox.core.v2.files.Metadata

newBuilder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected final java.lang.String id

clientModified

protected final java.util.Date clientModified

serverModified

protected final java.util.Date serverModified

rev

protected final java.lang.String rev

size

protected final long size

mediaInfo

protected final MediaInfo mediaInfo

symlinkInfo

protected final SymlinkInfo symlinkInfo

sharingInfo

protected final FileSharingInfo sharingInfo

isDownloadable

protected final boolean isDownloadable

exportInfo

protected final ExportInfo exportInfo

propertyGroups

protected final java.util.List<PropertyGroup> propertyGroups

hasExplicitSharedMembers

protected final java.lang.Boolean hasExplicitSharedMembers

contentHash

protected final java.lang.String contentHash

fileLockInfo

protected final FileLockMetadata fileLockInfo

Constructor Detail

FileMetadata

public FileMetadata(java.lang.String name,
                    java.lang.String id,
                    java.util.Date clientModified,
                    java.util.Date serverModified,
                    java.lang.String rev,
                    long size,
                    java.lang.String pathLower,
                    java.lang.String pathDisplay,
                    java.lang.String parentSharedFolderId,
                    MediaInfo mediaInfo,
                    SymlinkInfo symlinkInfo,
                    FileSharingInfo sharingInfo,
                    boolean isDownloadable,
                    ExportInfo exportInfo,
                    java.util.List<PropertyGroup> propertyGroups,
                    java.lang.Boolean hasExplicitSharedMembers,
                    java.lang.String contentHash,
                    FileLockMetadata fileLockInfo)

Use newBuilder to create instances of this class without specifying values for all optional fields.

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

id - A unique identifier for the file. Must have length of at least 1 and not be null.

clientModified - For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.

serverModified - The last time the file was modified on Dropbox. Must not be null.

rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.

size - The file size in bytes.

pathLower - The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.

pathDisplay - The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by DbxUserFilesRequests.listFolderContinue(String). This field will be null if the file or folder is not mounted.

parentSharedFolderId - Please use FileSharingInfo.getParentSharedFolderId() or FolderSharingInfo.getParentSharedFolderId() instead. Must match pattern "[-_0-9a-zA-Z:]+".

mediaInfo - Additional information if the file is a photo or video. This field will not be set on entries returned by DbxUserFilesRequests.listFolder(String), DbxUserFilesRequests.listFolderContinue(String), or DbxUserFilesRequests.getThumbnailBatch(List), starting December 2, 2019.

symlinkInfo - Set if this file is a symlink.

sharingInfo - Set if this file is contained in a shared folder.

isDownloadable - If true, file can be downloaded directly; else the file must be exported.

exportInfo - Information about format this file can be exported to. This filed must be set if getIsDownloadable() is set to false.

propertyGroups - Additional information if the file has custom properties with the property template specified. Must not contain a null item.

hasExplicitSharedMembers - This flag will only be present if include_has_explicit_shared_members is true in DbxUserFilesRequests.listFolder(String) or DbxUserFilesRequests.getMetadata(String). If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

contentHash - A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash page. Must have length of at least 64 and have length of at most 64.

fileLockInfo - If present, the metadata associated with the file's current lock.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

FileMetadata

public FileMetadata(java.lang.String name,
                    java.lang.String id,
                    java.util.Date clientModified,
                    java.util.Date serverModified,
                    java.lang.String rev,
                    long size)

None

The default values for unset fields will be used.

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

id - A unique identifier for the file. Must have length of at least 1 and not be null.

clientModified - For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.

serverModified - The last time the file was modified on Dropbox. Must not be null.

rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.

size - The file size in bytes.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getName

public java.lang.String getName()

The last component of the path (including extension). This never contains a slash.

Overrides:

getName in class Metadata

Returns:

value for this field, never null.

getId

public java.lang.String getId()

A unique identifier for the file.

Returns:

value for this field, never null.

getClientModified

public java.util.Date getClientModified()

For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.

Returns:

value for this field, never null.

getServerModified

public java.util.Date getServerModified()

The last time the file was modified on Dropbox.

Returns:

value for this field, never null.

getRev

public java.lang.String getRev()

A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.

Returns:

value for this field, never null.

getSize

public long getSize()

The file size in bytes.

Returns:

value for this field.

getPathLower

public java.lang.String getPathLower()

The lowercased full path in the user's Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.

Overrides:

getPathLower in class Metadata

Returns:

value for this field, or null if not present.

getPathDisplay

public java.lang.String getPathDisplay()

The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won't be returned by DbxUserFilesRequests.listFolderContinue(String). This field will be null if the file or folder is not mounted.

Overrides:

getPathDisplay in class Metadata

Returns:

value for this field, or null if not present.

getParentSharedFolderId

public java.lang.String getParentSharedFolderId()

Please use FileSharingInfo.getParentSharedFolderId() or FolderSharingInfo.getParentSharedFolderId() instead.

Overrides:

getParentSharedFolderId in class Metadata

Returns:

value for this field, or null if not present.

getMediaInfo

public MediaInfo getMediaInfo()

Additional information if the file is a photo or video. This field will not be set on entries returned by DbxUserFilesRequests.listFolder(String), DbxUserFilesRequests.listFolderContinue(String), or DbxUserFilesRequests.getThumbnailBatch(List), starting December 2, 2019.

Returns:

value for this field, or null if not present.

getSymlinkInfo

public SymlinkInfo getSymlinkInfo()

Set if this file is a symlink.

Returns:

value for this field, or null if not present.

getSharingInfo

public FileSharingInfo getSharingInfo()

Set if this file is contained in a shared folder.

Returns:

value for this field, or null if not present.

getIsDownloadable

public boolean getIsDownloadable()

If true, file can be downloaded directly; else the file must be exported.

Returns:

value for this field, or null if not present. Defaults to true.

getExportInfo

public ExportInfo getExportInfo()

Information about format this file can be exported to. This filed must be set if getIsDownloadable() is set to false.

Returns:

value for this field, or null if not present.

getPropertyGroups

public java.util.List<PropertyGroup> getPropertyGroups()

Additional information if the file has custom properties with the property template specified.

Returns:

value for this field, or null if not present.

getHasExplicitSharedMembers

public java.lang.Boolean getHasExplicitSharedMembers()

This flag will only be present if include_has_explicit_shared_members is true in DbxUserFilesRequests.listFolder(String) or DbxUserFilesRequests.getMetadata(String). If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

Returns:

value for this field, or null if not present.

getContentHash

public java.lang.String getContentHash()

A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash page.

Returns:

value for this field, or null if not present.

getFileLockInfo

public FileLockMetadata getFileLockInfo()

If present, the metadata associated with the file's current lock.

Returns:

value for this field, or null if not present.

newBuilder

public static FileMetadata.Builder newBuilder(java.lang.String name,
                                              java.lang.String id,
                                              java.util.Date clientModified,
                                              java.util.Date serverModified,
                                              java.lang.String rev,
                                              long size)

Returns a new builder for creating an instance of this class.

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

id - A unique identifier for the file. Must have length of at least 1 and not be null.

clientModified - For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.

serverModified - The last time the file was modified on Dropbox. Must not be null.

rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.

size - The file size in bytes.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Metadata

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Metadata

toString

public java.lang.String toString()

Overrides:

toString in class Metadata

toStringMultiline

public java.lang.String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Overrides:

toStringMultiline in class Metadata

Returns:

Formatted, multiline String representation of this object