com.dropbox.core.v2.files

Class CommitInfoWithProperties.Builder

java.lang.Object

com.dropbox.core.v2.files.CommitInfo.Builder

com.dropbox.core.v2.files.CommitInfoWithProperties.Builder

Enclosing class:

CommitInfoWithProperties

public static class CommitInfoWithProperties.Builder
extends CommitInfo.Builder

Builder for CommitInfoWithProperties.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<PropertyGroup>	propertyGroups

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

autorename, clientModified, mode, mute, path

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(String path)

Method Summary

Modifier and Type	Method and Description
CommitInfoWithProperties	build() Builds an instance of CommitInfoWithProperties configured with this builder's values
CommitInfoWithProperties.Builder	withAutorename(Boolean autorename) Set value for optional field.
CommitInfoWithProperties.Builder	withClientModified(Date clientModified) Set value for optional field.
CommitInfoWithProperties.Builder	withMode(WriteMode mode) Set value for optional field.
CommitInfoWithProperties.Builder	withMute(Boolean mute) Set value for optional field.
CommitInfoWithProperties.Builder	withPropertyGroups(List<PropertyGroup> propertyGroups) 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

propertyGroups

protected List<PropertyGroup> propertyGroups

Constructor Detail

Builder

protected Builder(String path)

Method Detail

withPropertyGroups

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

Set value for optional field.

Parameters:

propertyGroups - List of custom properties to add to file. Must not contain a null item.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMode

public CommitInfoWithProperties.Builder withMode(WriteMode mode)

Set value for optional field.

If left unset or set to null, defaults to WriteMode.ADD.

Overrides:

withMode in class CommitInfo.Builder

Parameters:

mode - Selects what to do if the file already exists. Defaults to WriteMode.ADD when set to null.

Returns:

this builder

withAutorename

public CommitInfoWithProperties.Builder withAutorename(Boolean autorename)

Set value for optional field.

If left unset or set to null, defaults to false.

Overrides:

withAutorename in class CommitInfo.Builder

Parameters:

autorename - If there's a conflict, as determined by the mode argument to DbxUserFilesRequests.upload(String), have the Dropbox server try to autorename the file to avoid conflict. Defaults to false when set to null.

Returns:

this builder

withClientModified

public CommitInfoWithProperties.Builder withClientModified(Date clientModified)

Set value for optional field.

Overrides:

withClientModified in class CommitInfo.Builder

Parameters:

clientModified - The value to store as the the clientModified argument to DbxUserFilesRequests.upload(String) timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

Returns:

this builder

withMute

public CommitInfoWithProperties.Builder withMute(Boolean mute)

Set value for optional field.

If left unset or set to null, defaults to false.

Overrides:

withMute in class CommitInfo.Builder

Parameters:

mute - Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification. Defaults to false when set to null.

Returns:

this builder

build

public CommitInfoWithProperties build()

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

Overrides:

build in class CommitInfo.Builder

Returns:

new instance of CommitInfoWithProperties