Package com.dropbox.core.v2.sharing

Class SharedFolderMetadata.Builder

java.lang.Object

com.dropbox.core.v2.sharing.SharedFolderMetadataBase.Builder

com.dropbox.core.v2.sharing.SharedFolderMetadata.Builder

Enclosing class:

SharedFolderMetadata

public static class SharedFolderMetadata.Builder
extends SharedFolderMetadataBase.Builder

Builder for SharedFolderMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessInheritance	accessInheritance
protected String	folderId
protected SharedContentLinkMetadata	linkMetadata
protected final String	name
protected List<FolderPermission>	permissions
protected final FolderPolicy	policy
protected final String	previewUrl
protected final String	sharedFolderId
protected final Date	timeInvited

Fields inherited from class com.dropbox.core.v2.sharing.SharedFolderMetadataBase.Builder

accessType, isInsideTeamFolder, isTeamFolder, ownerDisplayNames, ownerTeam, parentFolderName, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder, String name, FolderPolicy policy, String previewUrl, String sharedFolderId, Date timeInvited)

Method Summary

Modifier and Type	Method	Description
SharedFolderMetadata	build()	Builds an instance of SharedFolderMetadata configured with this builder's values
SharedFolderMetadata.Builder	withAccessInheritance(AccessInheritance accessInheritance)	Set value for optional field.
SharedFolderMetadata.Builder	withFolderId(String folderId)	Set value for optional field.
SharedFolderMetadata.Builder	withLinkMetadata(SharedContentLinkMetadata linkMetadata)	Set value for optional field.
SharedFolderMetadata.Builder	withOwnerDisplayNames(List<String> ownerDisplayNames)	Set value for optional field.
SharedFolderMetadata.Builder	withOwnerTeam(Team ownerTeam)	Set value for optional field.
SharedFolderMetadata.Builder	withParentFolderName(String parentFolderName)	Set value for optional field.
SharedFolderMetadata.Builder	withParentSharedFolderId(String parentSharedFolderId)	Set value for optional field.
SharedFolderMetadata.Builder	withPathDisplay(String pathDisplay)	Set value for optional field.
SharedFolderMetadata.Builder	withPathLower(String pathLower)	Set value for optional field.
SharedFolderMetadata.Builder	withPermissions(List<FolderPermission> permissions)	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

name

protected final String name

policy

protected final FolderPolicy policy

previewUrl

protected final String previewUrl

sharedFolderId

protected final String sharedFolderId

timeInvited

protected final Date timeInvited

linkMetadata

protected SharedContentLinkMetadata linkMetadata

permissions

protected List<FolderPermission> permissions

accessInheritance

protected AccessInheritance accessInheritance

folderId

protected String folderId

Constructor Details

Builder

protected Builder(AccessLevel accessType,
 boolean isInsideTeamFolder,
 boolean isTeamFolder,
 String name,
 FolderPolicy policy,
 String previewUrl,
 String sharedFolderId,
 Date timeInvited)

Method Details

withLinkMetadata

public SharedFolderMetadata.Builder withLinkMetadata(SharedContentLinkMetadata linkMetadata)

Set value for optional field.

Parameters:

linkMetadata - The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.

Returns:

this builder

withPermissions

public SharedFolderMetadata.Builder withPermissions(List<FolderPermission> permissions)

Set value for optional field.

Parameters:

permissions - Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. Must not contain a null item.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withAccessInheritance

public SharedFolderMetadata.Builder withAccessInheritance(AccessInheritance accessInheritance)

Set value for optional field.

If left unset or set to null, defaults to AccessInheritance.INHERIT.

Parameters:

accessInheritance - Whether the folder inherits its members from its parent. Must not be null. Defaults to AccessInheritance.INHERIT when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withFolderId

public SharedFolderMetadata.Builder withFolderId(String folderId)

Set value for optional field.

Parameters:

folderId - The ID of the content. Must have length of at least 4 and match pattern "id:.+".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withOwnerDisplayNames

public SharedFolderMetadata.Builder withOwnerDisplayNames(List<String> ownerDisplayNames)

Set value for optional field.

Overrides:

withOwnerDisplayNames in class SharedFolderMetadataBase.Builder

Parameters:

ownerDisplayNames - The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. Must not contain a null item.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withOwnerTeam

public SharedFolderMetadata.Builder withOwnerTeam(Team ownerTeam)

Set value for optional field.

Overrides:

withOwnerTeam in class SharedFolderMetadataBase.Builder

Parameters:

ownerTeam - The team that owns the folder. This field is not present if the folder is not owned by a team.

Returns:

this builder

withParentSharedFolderId

public SharedFolderMetadata.Builder withParentSharedFolderId(String parentSharedFolderId)

Set value for optional field.

Overrides:

withParentSharedFolderId in class SharedFolderMetadataBase.Builder

Parameters:

parentSharedFolderId - The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. Must match pattern "[-_0-9a-zA-Z:]+".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withPathDisplay

public SharedFolderMetadata.Builder withPathDisplay(String pathDisplay)

Set value for optional field.

Overrides:

withPathDisplay in class SharedFolderMetadataBase.Builder

Parameters:

pathDisplay - The full path of this shared folder. Absent for unmounted folders.

Returns:

this builder

withPathLower

public SharedFolderMetadata.Builder withPathLower(String pathLower)

Set value for optional field.

Overrides:

withPathLower in class SharedFolderMetadataBase.Builder

Parameters:

pathLower - The lower-cased full path of this shared folder. Absent for unmounted folders.

Returns:

this builder

withParentFolderName

public SharedFolderMetadata.Builder withParentFolderName(String parentFolderName)

Set value for optional field.

Overrides:

withParentFolderName in class SharedFolderMetadataBase.Builder

Parameters:

parentFolderName - Display name for the parent folder.

Returns:

this builder

build

public SharedFolderMetadata build()

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

Overrides:

build in class SharedFolderMetadataBase.Builder

Returns:

new instance of SharedFolderMetadata