public class FolderMetadata extends Metadata
Modifier and Type | Class and Description |
---|---|
static class |
FolderMetadata.Builder
Builder for
FolderMetadata . |
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 |
name, parentSharedFolderId, pathDisplay, pathLower
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. |
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.
|
newBuilder
protected final java.lang.String id
protected final java.lang.String sharedFolderId
protected final FolderSharingInfo sharingInfo
protected final java.util.List<PropertyGroup> propertyGroups
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)
newBuilder
to create instances of this class without
specifying values for all optional fields.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.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public FolderMetadata(java.lang.String name, java.lang.String id)
The default values for unset fields will be used.
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
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public java.lang.String getName()
public java.lang.String getId()
null
.public java.lang.String getPathLower()
getPathLower
in class Metadata
null
if not present.public java.lang.String getPathDisplay()
DbxUserFilesRequests.listFolderContinue(String)
. This field will be null
if the file or folder is not mounted.getPathDisplay
in class Metadata
null
if not present.public java.lang.String getParentSharedFolderId()
FileSharingInfo.getParentSharedFolderId()
or FolderSharingInfo.getParentSharedFolderId()
instead.getParentSharedFolderId
in class Metadata
null
if not present.public java.lang.String getSharedFolderId()
getSharingInfo()
instead.null
if not present.public FolderSharingInfo getSharingInfo()
null
if not present.public java.util.List<PropertyGroup> getPropertyGroups()
null
if not present.public static FolderMetadata.Builder newBuilder(java.lang.String name, java.lang.String id)
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
.java.lang.IllegalArgumentException
- If any argument does not meet its
preconditions.public java.lang.String toStringMultiline()
The returned String may contain newlines.
toStringMultiline
in class Metadata