com.dropbox.core.v2.files

Class DeletedMetadata

java.lang.Object

com.dropbox.core.v2.files.Metadata

com.dropbox.core.v2.files.DeletedMetadata

public class DeletedMetadata
extends Metadata

Indicates that there used to be a file or folder at this path, but it no longer exists.

Nested Class Summary

Nested Classes

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

Field Summary

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

name, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Constructor and Description
DeletedMetadata(String name) Indicates that there used to be a file or folder at this path, but it no longer exists.
DeletedMetadata(String name, String pathLower, String pathDisplay, String parentSharedFolderId) Indicates that there used to be a file or folder at this path, but it no longer exists.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() The last component of the path (including extension).
String	getParentSharedFolderId() Deprecated.
String	getPathDisplay() The cased path to be used for display purposes only.
String	getPathLower() The lowercased full path in the user's Dropbox.
int	hashCode()
static DeletedMetadata.Builder	newBuilder(String name) Returns a new builder for creating an instance of this class.
String	toString()
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

Constructor Detail

DeletedMetadata

public DeletedMetadata(String name,
                       String pathLower,
                       String pathDisplay,
                       String parentSharedFolderId)

Indicates that there used to be a file or folder at this path, but it no longer exists.

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.

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. Changes to 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 - Deprecated. Please use FileSharingInfo.getParentSharedFolderId() or FolderSharingInfo.getParentSharedFolderId() instead. Must match pattern "[-_0-9a-zA-Z:]+".

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

DeletedMetadata

public DeletedMetadata(String name)

Indicates that there used to be a file or folder at this path, but it no longer exists.

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:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getName

public 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.

getPathLower

public 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 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. Changes to 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 String getParentSharedFolderId()

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

Overrides:

getParentSharedFolderId in class Metadata

Returns:

value for this field, or null if not present.

newBuilder

public static DeletedMetadata.Builder newBuilder(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:

IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Metadata

equals

public boolean equals(Object obj)

Overrides:

equals in class Metadata

toString

public String toString()

Overrides:

toString in class Metadata

toStringMultiline

public 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