com.dropbox.core.v2.files

Class CommitInfo.Builder

java.lang.Object

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

Enclosing class:

CommitInfo

public static class CommitInfo.Builder
extends java.lang.Object

Builder for CommitInfo.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autorename
protected java.util.Date	clientModified
protected WriteMode	mode
protected boolean	mute
protected java.lang.String	path
protected java.util.List<PropertyGroup>	propertyGroups
protected boolean	strictConflict

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(java.lang.String path)

Method Summary

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

path

protected final java.lang.String path

mode

protected WriteMode mode

autorename

protected boolean autorename

clientModified

protected java.util.Date clientModified

mute

protected boolean mute

propertyGroups

protected java.util.List<PropertyGroup> propertyGroups

strictConflict

protected boolean strictConflict

Constructor Detail

Builder

protected Builder(java.lang.String path)

Method Detail

withMode

public CommitInfo.Builder withMode(WriteMode mode)

Set value for optional field.

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

Parameters:

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

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

withAutorename

public CommitInfo.Builder withAutorename(java.lang.Boolean autorename)

Set value for optional field.

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

Parameters:

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

Returns:

this builder

withClientModified

public CommitInfo.Builder withClientModified(java.util.Date clientModified)

Set value for optional field.

Parameters:

clientModified - The value to store as the CommitInfo.getClientModified() 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 CommitInfo.Builder withMute(java.lang.Boolean mute)

Set value for optional field.

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

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

withPropertyGroups

public CommitInfo.Builder withPropertyGroups(java.util.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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

withStrictConflict

public CommitInfo.Builder withStrictConflict(java.lang.Boolean strictConflict)

Set value for optional field.

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

Parameters:

strictConflict - Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when CommitInfo.getMode() = WriteMode.getUpdateValue() and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. Defaults to false when set to null.

Returns:

this builder

build

public CommitInfo build()

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

Returns:

new instance of CommitInfo