com.dropbox.core.v2.files

Class FolderMetadata

java.lang.Object

com.dropbox.core.v2.files.Metadata

com.dropbox.core.v2.files.FolderMetadata

public class FolderMetadata
extends Metadata

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id
protected java.util.List<PropertyGroup>	propertyGroups
protected java.lang.String	sharedFolderId
protected FolderSharingInfo	sharingInfo

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

name, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Constructor and Description
FolderMetadata(java.lang.String name, java.lang.String id) None
FolderMetadata(java.lang.String name, java.lang.String id, java.lang.String pathLower, java.lang.String pathDisplay, java.lang.String parentSharedFolderId, java.lang.String sharedFolderId, FolderSharingInfo sharingInfo, java.util.List<PropertyGroup> propertyGroups) 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.lang.String	getId() A unique identifier for the folder.
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	getSharedFolderId() Please use getSharingInfo() instead.
FolderSharingInfo	getSharingInfo() Set if the folder is contained in a shared folder or is a shared folder mount point.
int	hashCode()
static FolderMetadata.Builder	newBuilder(java.lang.String name, java.lang.String id) 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

sharedFolderId

protected final java.lang.String sharedFolderId

sharingInfo

protected final FolderSharingInfo sharingInfo

propertyGroups

protected final java.util.List<PropertyGroup> propertyGroups

Constructor Detail

FolderMetadata

public FolderMetadata(java.lang.String name,
                      java.lang.String id,
                      java.lang.String pathLower,
                      java.lang.String pathDisplay,
                      java.lang.String parentSharedFolderId,
                      java.lang.String sharedFolderId,
                      FolderSharingInfo sharingInfo,
                      java.util.List<PropertyGroup> propertyGroups)

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 folder. Must have length of at least 1 and 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:]+".

sharedFolderId - Please use getSharingInfo() instead. Must match pattern "[-_0-9a-zA-Z:]+".

sharingInfo - Set if the folder is contained in a shared folder or is a shared folder mount point.

propertyGroups - Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders. Must not contain a null item.

Throws:

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

FolderMetadata

public FolderMetadata(java.lang.String name,
                      java.lang.String id)

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 folder. Must have length of at least 1 and 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.

Overrides:

getName in class Metadata

Returns:

value for this field, never null.

getId

public java.lang.String getId()

A unique identifier for the folder.

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.

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.

getSharedFolderId

public java.lang.String getSharedFolderId()

Please use getSharingInfo() instead.

Returns:

value for this field, or null if not present.

getSharingInfo

public FolderSharingInfo getSharingInfo()

Set if the folder is contained in a shared folder or is a shared folder mount point.

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. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

Returns:

value for this field, or null if not present.

newBuilder

public static FolderMetadata.Builder newBuilder(java.lang.String name,
                                                java.lang.String id)

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 folder. Must have length of at least 1 and 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 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