com.dropbox.core.v2.sharing

Class SharedFileMetadata.Builder

java.lang.Object

com.dropbox.core.v2.sharing.SharedFileMetadata.Builder

Enclosing class:

SharedFileMetadata

public static class SharedFileMetadata.Builder
extends Object

Builder for SharedFileMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id
protected String	name
protected Team	ownerTeam
protected String	parentSharedFolderId
protected String	pathDisplay
protected String	pathLower
protected List<FilePermission>	permissions
protected FolderPolicy	policy
protected String	previewUrl
protected Date	timeInvited

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(FolderPolicy policy, String previewUrl, String name, String id)

Method Summary

Modifier and Type	Method and Description
SharedFileMetadata	build() Builds an instance of SharedFileMetadata configured with this builder's values
SharedFileMetadata.Builder	withOwnerTeam(Team ownerTeam) Set value for optional field.
SharedFileMetadata.Builder	withParentSharedFolderId(String parentSharedFolderId) Set value for optional field.
SharedFileMetadata.Builder	withPathDisplay(String pathDisplay) Set value for optional field.
SharedFileMetadata.Builder	withPathLower(String pathLower) Set value for optional field.
SharedFileMetadata.Builder	withPermissions(List<FilePermission> permissions) Set value for optional field.
SharedFileMetadata.Builder	withTimeInvited(Date timeInvited) Set value for optional field.

Methods inherited from class java.lang.Object

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

Field Detail

policy

protected final FolderPolicy policy

previewUrl

protected final String previewUrl

name

protected final String name

id

protected final String id

permissions

protected List<FilePermission> permissions

ownerTeam

protected Team ownerTeam

parentSharedFolderId

protected String parentSharedFolderId

pathLower

protected String pathLower

pathDisplay

protected String pathDisplay

timeInvited

protected Date timeInvited

Constructor Detail

Builder

protected Builder(FolderPolicy policy,
                  String previewUrl,
                  String name,
                  String id)

Method Detail

withPermissions

public SharedFileMetadata.Builder withPermissions(List<FilePermission> permissions)

Set value for optional field.

Parameters:

permissions - The sharing permissions that requesting user has on this file. This corresponds to the entries given in the actions argument to DbxUserSharingRequests.getFileMetadataBatch(List,List) or the actions argument to DbxUserSharingRequests.getFileMetadata(String,List). Must not contain a null item.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withOwnerTeam

public SharedFileMetadata.Builder withOwnerTeam(Team ownerTeam)

Set value for optional field.

Parameters:

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

Returns:

this builder

withParentSharedFolderId

public SharedFileMetadata.Builder withParentSharedFolderId(String parentSharedFolderId)

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withPathLower

public SharedFileMetadata.Builder withPathLower(String pathLower)

Set value for optional field.

Parameters:

pathLower - The lower-case full path of this file. Absent for unmounted files.

Returns:

this builder

withPathDisplay

public SharedFileMetadata.Builder withPathDisplay(String pathDisplay)

Set value for optional field.

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. Absent for unmounted files.

Returns:

this builder

withTimeInvited

public SharedFileMetadata.Builder withTimeInvited(Date timeInvited)

Set value for optional field.

Parameters:

timeInvited - Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Returns:

this builder

build

public SharedFileMetadata build()

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

Returns:

new instance of SharedFileMetadata