com.dropbox.core.v2.files

Class DownloadError

java.lang.Object

com.dropbox.core.v2.files.DownloadError

public final class DownloadError
extends java.lang.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 and Description
static class	DownloadError.Tag Discriminating tag type for DownloadError.

Field Summary

Fields

Modifier and Type	Field and Description
static DownloadError	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.
static DownloadError	UNSUPPORTED_FILE This file type cannot be downloaded directly; use DbxUserFilesRequests.export(String) instead.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
LookupError	getPathValue() This instance must be tagged as DownloadError.Tag.PATH.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag DownloadError.Tag.OTHER, false otherwise.
boolean	isPath() Returns true if this instance has the tag DownloadError.Tag.PATH, false otherwise.
boolean	isUnsupportedFile() Returns true if this instance has the tag DownloadError.Tag.UNSUPPORTED_FILE, false otherwise.
static DownloadError	path(LookupError value) Returns an instance of DownloadError that has its tag set to DownloadError.Tag.PATH.
DownloadError.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

UNSUPPORTED_FILE

public static final DownloadError UNSUPPORTED_FILE

This file type cannot be downloaded directly; use DbxUserFilesRequests.export(String) instead.

OTHER

public static final DownloadError 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 DownloadError.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 DownloadError.

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

Returns:

the tag for this instance.

isPath

public boolean isPath()

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

Returns:

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

path

public static DownloadError path(LookupError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

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

Returns:

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

Throws:

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

isUnsupportedFile

public boolean isUnsupportedFile()

Returns true if this instance has the tag DownloadError.Tag.UNSUPPORTED_FILE, false otherwise.

Returns:

true if this instance is tagged as DownloadError.Tag.UNSUPPORTED_FILE, false otherwise.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as DownloadError.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