public class CommitInfoWithProperties extends CommitInfo
Modifier and Type | Class and Description |
---|---|
static class |
CommitInfoWithProperties.Builder
Builder for
CommitInfoWithProperties . |
Modifier and Type | Field and Description |
---|---|
protected List<PropertyGroup> |
propertyGroups |
autorename, clientModified, mode, mute, path
Constructor and Description |
---|
CommitInfoWithProperties(String path)
The default values for unset fields will be used.
|
CommitInfoWithProperties(String path,
WriteMode mode,
boolean autorename,
Date clientModified,
boolean mute,
List<PropertyGroup> propertyGroups)
Use
newBuilder to create instances of this class without
specifying values for all optional fields. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
List<PropertyGroup> |
getPropertyGroups()
List of custom properties to add to file.
|
int |
hashCode() |
static CommitInfoWithProperties.Builder |
newBuilder(String path)
Returns a new builder for creating an instance of this class.
|
String |
toString() |
String |
toStringMultiline()
Returns a String representation of this object formatted for easier
readability.
|
getAutorename, getClientModified, getMode, getMute, getPath
protected final List<PropertyGroup> propertyGroups
public CommitInfoWithProperties(String path, WriteMode mode, boolean autorename, Date clientModified, boolean mute, List<PropertyGroup> propertyGroups)
newBuilder
to create instances of this class without
specifying values for all optional fields.path
- Path in the user's Dropbox to save the file. Must match
pattern "/(.|[\\r\\n])*
" and not be null
.mode
- Selects what to do if the file already exists.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.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.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.propertyGroups
- List of custom properties to add to file. Must not
contain a null
item.IllegalArgumentException
- If any argument does not meet its
preconditions.public CommitInfoWithProperties(String path)
path
- Path in the user's Dropbox to save the file. Must match
pattern "/(.|[\\r\\n])*
" and not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public List<PropertyGroup> getPropertyGroups()
null
if not present.public static CommitInfoWithProperties.Builder newBuilder(String path)
path
- Path in the user's Dropbox to save the file. Must match
pattern "/(.|[\\r\\n])*
" and not be null
.IllegalArgumentException
- If any argument does not meet its
preconditions.public int hashCode()
hashCode
in class CommitInfo
public boolean equals(Object obj)
equals
in class CommitInfo
public String toString()
toString
in class CommitInfo
public String toStringMultiline()
The returned String may contain newlines.
toStringMultiline
in class CommitInfo