Package com.dropbox.core.v2.files

Class FolderMetadata.Builder

java.lang.Object

com.dropbox.core.v2.files.Metadata.Builder

com.dropbox.core.v2.files.FolderMetadata.Builder

Enclosing class:

FolderMetadata

public static class FolderMetadata.Builder
extends Metadata.Builder

Builder for FolderMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	id
protected List<PropertyGroup>	propertyGroups
protected String	sharedFolderId
protected FolderSharingInfo	sharingInfo

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

name, parentSharedFolderId, pathDisplay, pathLower, previewUrl

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String name, String id)

Method Summary

Modifier and Type	Method	Description
FolderMetadata	build()	Builds an instance of FolderMetadata configured with this builder's values
FolderMetadata.Builder	withParentSharedFolderId(String parentSharedFolderId)	Deprecated.
FolderMetadata.Builder	withPathDisplay(String pathDisplay)	Set value for optional field.
FolderMetadata.Builder	withPathLower(String pathLower)	Set value for optional field.
FolderMetadata.Builder	withPreviewUrl(String previewUrl)	Set value for optional field.
FolderMetadata.Builder	withPropertyGroups(List<PropertyGroup> propertyGroups)	Set value for optional field.
FolderMetadata.Builder	withSharedFolderId(String sharedFolderId)	Deprecated.
FolderMetadata.Builder	withSharingInfo(FolderSharingInfo sharingInfo)	Set value for optional field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

id

protected final String id

sharedFolderId

protected String sharedFolderId

sharingInfo

protected FolderSharingInfo sharingInfo

propertyGroups

protected List<PropertyGroup> propertyGroups

Constructor Details

Builder

protected Builder(String name,
 String id)

Method Details

withSharedFolderId

@Deprecated
public FolderMetadata.Builder withSharedFolderId(String sharedFolderId)

Deprecated.

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withSharingInfo

public FolderMetadata.Builder withSharingInfo(FolderSharingInfo sharingInfo)

Set value for optional field.

Parameters:

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

Returns:

this builder

withPropertyGroups

public FolderMetadata.Builder withPropertyGroups(List<PropertyGroup> propertyGroups)

Set value for optional field.

Parameters:

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.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withPathLower

public FolderMetadata.Builder withPathLower(String pathLower)

Set value for optional field.

Overrides:

withPathLower in class Metadata.Builder

Parameters:

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.

Returns:

this builder

withPathDisplay

public FolderMetadata.Builder withPathDisplay(String pathDisplay)

Set value for optional field.

Overrides:

withPathDisplay in class Metadata.Builder

Parameters:

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 DbxAppFilesRequests.listFolderContinue(String). This field will be null if the file or folder is not mounted.

Returns:

this builder

withParentSharedFolderId

@Deprecated
public FolderMetadata.Builder withParentSharedFolderId(String parentSharedFolderId)

Deprecated.

Set value for optional field.

Overrides:

withParentSharedFolderId in class Metadata.Builder

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withPreviewUrl

public FolderMetadata.Builder withPreviewUrl(String previewUrl)

Set value for optional field.

Overrides:

withPreviewUrl in class Metadata.Builder

Parameters:

previewUrl - The preview URL of the file.

Returns:

this builder

build

public FolderMetadata build()

Builds an instance of FolderMetadata configured with this builder's values

Overrides:

build in class Metadata.Builder

Returns:

new instance of FolderMetadata