com.dropbox.core.v2.files

Class FileMetadata.Builder

java.lang.Object

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

com.dropbox.core.v2.files.FileMetadata.Builder

Enclosing class:

FileMetadata

public static class FileMetadata.Builder
extends Metadata.Builder

Builder for FileMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	clientModified
protected Boolean	hasExplicitSharedMembers
protected String	id
protected MediaInfo	mediaInfo
protected List<PropertyGroup>	propertyGroups
protected String	rev
protected Date	serverModified
protected FileSharingInfo	sharingInfo
protected long	size

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

name, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(String name, String id, Date clientModified, Date serverModified, String rev, long size)

Method Summary

Modifier and Type	Method and Description
FileMetadata	build() Builds an instance of FileMetadata configured with this builder's values
FileMetadata.Builder	withHasExplicitSharedMembers(Boolean hasExplicitSharedMembers) Set value for optional field.
FileMetadata.Builder	withMediaInfo(MediaInfo mediaInfo) Set value for optional field.
FileMetadata.Builder	withParentSharedFolderId(String parentSharedFolderId) Set value for optional field.
FileMetadata.Builder	withPathDisplay(String pathDisplay) Set value for optional field.
FileMetadata.Builder	withPathLower(String pathLower) Set value for optional field.
FileMetadata.Builder	withPropertyGroups(List<PropertyGroup> propertyGroups) Set value for optional field.
FileMetadata.Builder	withSharingInfo(FileSharingInfo 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 Detail

id

protected final String id

clientModified

protected final Date clientModified

serverModified

protected final Date serverModified

rev

protected final String rev

size

protected final long size

mediaInfo

protected MediaInfo mediaInfo

sharingInfo

protected FileSharingInfo sharingInfo

propertyGroups

protected List<PropertyGroup> propertyGroups

hasExplicitSharedMembers

protected Boolean hasExplicitSharedMembers

Constructor Detail

Builder

protected Builder(String name,
                  String id,
                  Date clientModified,
                  Date serverModified,
                  String rev,
                  long size)

Method Detail

withMediaInfo

public FileMetadata.Builder withMediaInfo(MediaInfo mediaInfo)

Set value for optional field.

Parameters:

mediaInfo - Additional information if the file is a photo or video.

Returns:

this builder

withSharingInfo

public FileMetadata.Builder withSharingInfo(FileSharingInfo sharingInfo)

Set value for optional field.

Parameters:

sharingInfo - Set if this file is contained in a shared folder.

Returns:

this builder

withPropertyGroups

public FileMetadata.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. Must not contain a null item.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withHasExplicitSharedMembers

public FileMetadata.Builder withHasExplicitSharedMembers(Boolean hasExplicitSharedMembers)

Set value for optional field.

Parameters:

hasExplicitSharedMembers - This flag will only be present if include_has_explicit_shared_members is true in DbxUserFilesRequests.listFolder(String) or DbxUserFilesRequests.getMetadata(String). If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

Returns:

this builder

withPathLower

public FileMetadata.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 FileMetadata.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. Changes to 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.

Returns:

this builder

withParentSharedFolderId

public FileMetadata.Builder withParentSharedFolderId(String parentSharedFolderId)

Set value for optional field.

Overrides:

withParentSharedFolderId in class Metadata.Builder

Parameters:

parentSharedFolderId - 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.

build

public FileMetadata build()

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

Overrides:

build in class Metadata.Builder

Returns:

new instance of FileMetadata