Package com.dropbox.core.v2.files

Class UploadError

java.lang.Object

com.dropbox.core.v2.files.UploadError

public final class UploadError
extends Object

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UploadError.Tag	Discriminating tag type for UploadError.

Field Summary

Fields

Modifier and Type	Field	Description
static final UploadError	CONTENT_HASH_MISMATCH	The content received by the Dropbox server in this call does not match the provided content hash.
static final UploadError	ENCRYPTION_NOT_SUPPORTED	The file is required to be encrypted, which is not supported in our public API.
static final UploadError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final UploadError	PAYLOAD_TOO_LARGE	The request payload must be at most 150 MiB.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
UploadWriteFailed	getPathValue()	Unable to save the uploaded contents to a file.
InvalidPropertyGroupError	getPropertiesErrorValue()	The supplied property group is invalid.
int	hashCode()
boolean	isContentHashMismatch()	Returns true if this instance has the tag UploadError.Tag.CONTENT_HASH_MISMATCH, false otherwise.
boolean	isEncryptionNotSupported()	Returns true if this instance has the tag UploadError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UploadError.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag UploadError.Tag.PATH, false otherwise.
boolean	isPayloadTooLarge()	Returns true if this instance has the tag UploadError.Tag.PAYLOAD_TOO_LARGE, false otherwise.
boolean	isPropertiesError()	Returns true if this instance has the tag UploadError.Tag.PROPERTIES_ERROR, false otherwise.
static UploadError	path(UploadWriteFailed value)	Returns an instance of UploadError that has its tag set to UploadError.Tag.PATH.
static UploadError	propertiesError(InvalidPropertyGroupError value)	Returns an instance of UploadError that has its tag set to UploadError.Tag.PROPERTIES_ERROR.
UploadError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PAYLOAD_TOO_LARGE

public static final UploadError PAYLOAD_TOO_LARGE

The request payload must be at most 150 MiB.

CONTENT_HASH_MISMATCH

public static final UploadError CONTENT_HASH_MISMATCH

The content received by the Dropbox server in this call does not match the provided content hash.

ENCRYPTION_NOT_SUPPORTED

public static final UploadError ENCRYPTION_NOT_SUPPORTED

The file is required to be encrypted, which is not supported in our public API.

OTHER

public static final UploadError OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public UploadError.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this UploadError.

If a tag returned by the server is unrecognized by this SDK, the UploadError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isPath

public boolean isPath()

Returns true if this instance has the tag UploadError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.PATH, false otherwise.

path

public static UploadError path(UploadWriteFailed value)

Returns an instance of UploadError that has its tag set to UploadError.Tag.PATH.

Unable to save the uploaded contents to a file.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadError with its tag set to UploadError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public UploadWriteFailed getPathValue()

Unable to save the uploaded contents to a file.

This instance must be tagged as UploadError.Tag.PATH.

Returns:

The UploadWriteFailed value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isPropertiesError

public boolean isPropertiesError()

Returns true if this instance has the tag UploadError.Tag.PROPERTIES_ERROR, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.PROPERTIES_ERROR, false otherwise.

propertiesError

public static UploadError propertiesError(InvalidPropertyGroupError value)

Returns an instance of UploadError that has its tag set to UploadError.Tag.PROPERTIES_ERROR.

The supplied property group is invalid. The file has uploaded without property groups.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadError with its tag set to UploadError.Tag.PROPERTIES_ERROR.

Throws:

IllegalArgumentException - if value is null.

getPropertiesErrorValue

public InvalidPropertyGroupError getPropertiesErrorValue()

The supplied property group is invalid. The file has uploaded without property groups.

This instance must be tagged as UploadError.Tag.PROPERTIES_ERROR.

Returns:

The InvalidPropertyGroupError value associated with this instance if isPropertiesError() is true.

Throws:

IllegalStateException - If isPropertiesError() is false.

isPayloadTooLarge

public boolean isPayloadTooLarge()

Returns true if this instance has the tag UploadError.Tag.PAYLOAD_TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.PAYLOAD_TOO_LARGE, false otherwise.

isContentHashMismatch

public boolean isContentHashMismatch()

Returns true if this instance has the tag UploadError.Tag.CONTENT_HASH_MISMATCH, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.CONTENT_HASH_MISMATCH, false otherwise.

isEncryptionNotSupported

public boolean isEncryptionNotSupported()

Returns true if this instance has the tag UploadError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.

isOther

public boolean isOther()

Returns true if this instance has the tag UploadError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as UploadError.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object