Package com.dropbox.core.v2.files

Class UploadErrorWithProperties

java.lang.Object

com.dropbox.core.v2.files.UploadErrorWithProperties

public final class UploadErrorWithProperties
extends java.lang.Object

This class is a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UploadErrorWithProperties.Tag	Discriminating tag type for UploadErrorWithProperties.

Field Summary

Fields

Modifier and Type	Field	Description
static UploadErrorWithProperties	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
UploadWriteFailed	getPathValue()	Unable to save the uploaded contents to a file.
InvalidPropertyGroupError	getPropertiesErrorValue()	The supplied property group is invalid.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag UploadErrorWithProperties.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag UploadErrorWithProperties.Tag.PATH, false otherwise.
boolean	isPropertiesError()	Returns true if this instance has the tag UploadErrorWithProperties.Tag.PROPERTIES_ERROR, false otherwise.
static UploadErrorWithProperties	path(UploadWriteFailed value)	Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.Tag.PATH.
static UploadErrorWithProperties	propertiesError(InvalidPropertyGroupError value)	Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.Tag.PROPERTIES_ERROR.
UploadErrorWithProperties.Tag	tag()	Returns the tag for this instance.
java.lang.String	toString()
java.lang.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 Detail

OTHER

public static final UploadErrorWithProperties 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 Detail

tag

public UploadErrorWithProperties.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 UploadErrorWithProperties.

Returns:

the tag for this instance.

isPath

public boolean isPath()

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

Returns:

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

path

public static UploadErrorWithProperties path(UploadWriteFailed value)

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

Unable to save the uploaded contents to a file.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getPathValue

public UploadWriteFailed getPathValue()

Unable to save the uploaded contents to a file.

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

Returns:

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

Throws:

java.lang.IllegalStateException - If isPath() is false.

isPropertiesError

public boolean isPropertiesError()

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

Returns:

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

propertiesError

public static UploadErrorWithProperties propertiesError(InvalidPropertyGroupError value)

Returns an instance of UploadErrorWithProperties that has its tag set to UploadErrorWithProperties.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 UploadErrorWithProperties with its tag set to UploadErrorWithProperties.Tag.PROPERTIES_ERROR.

Throws:

java.lang.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 UploadErrorWithProperties.Tag.PROPERTIES_ERROR.

Returns:

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

Throws:

java.lang.IllegalStateException - If isPropertiesError() is false.

isOther

public boolean isOther()

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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