Package com.dropbox.core.v2.files

Class Metadata

java.lang.Object

com.dropbox.core.v2.files.Metadata

Direct Known Subclasses:

DeletedMetadata, FileMetadata, FolderMetadata

public class Metadata
extends java.lang.Object

Metadata for a file or folder.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	name
protected java.lang.String	parentSharedFolderId
protected java.lang.String	pathDisplay
protected java.lang.String	pathLower

Constructor Summary

Constructors

Constructor	Description
Metadata(java.lang.String name)	Metadata for a file or folder.
Metadata(java.lang.String name, java.lang.String pathLower, java.lang.String pathDisplay, java.lang.String parentSharedFolderId)	Metadata for a file or folder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
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.
int	hashCode()
static Metadata.Builder	newBuilder(java.lang.String name)	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 java.lang.Object

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

Field Detail

name

protected final java.lang.String name

pathLower

protected final java.lang.String pathLower

pathDisplay

protected final java.lang.String pathDisplay

parentSharedFolderId

protected final java.lang.String parentSharedFolderId

Constructor Detail

Metadata

public Metadata(java.lang.String name,
                java.lang.String pathLower,
                java.lang.String pathDisplay,
                java.lang.String parentSharedFolderId)

Metadata for a file or folder.

Use newBuilder(java.lang.String) 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.

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:]+".

Throws:

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

Metadata

public Metadata(java.lang.String name)

Metadata for a file or folder.

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.

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.

Returns:

value for this field, never null.

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.

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.

Returns:

value for this field, or null if not present.

getParentSharedFolderId

public java.lang.String getParentSharedFolderId()

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

Returns:

value for this field, or null if not present.

newBuilder

public static Metadata.Builder newBuilder(java.lang.String name)

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.

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 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.String toStringMultiline()

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

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object