com.dropbox.core.v2.files

Class DownloadZipError

java.lang.Object

com.dropbox.core.v2.files.DownloadZipError

public final class DownloadZipError
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	DownloadZipError.Tag Discriminating tag type for DownloadZipError.

Field Summary

Fields

Modifier and Type	Field and Description
static DownloadZipError	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.
static DownloadZipError	TOO_LARGE The folder or a file is too large to download.
static DownloadZipError	TOO_MANY_FILES The folder has too many files to download.

Method Summary

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

TOO_LARGE

public static final DownloadZipError TOO_LARGE

The folder or a file is too large to download.

TOO_MANY_FILES

public static final DownloadZipError TOO_MANY_FILES

The folder has too many files to download.

OTHER

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

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

Returns:

the tag for this instance.

isPath

public boolean isPath()

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

Returns:

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

path

public static DownloadZipError path(LookupError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

java.lang.IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

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

Returns:

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

Throws:

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

isTooLarge

public boolean isTooLarge()

Returns true if this instance has the tag DownloadZipError.Tag.TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as DownloadZipError.Tag.TOO_LARGE, false otherwise.

isTooManyFiles

public boolean isTooManyFiles()

Returns true if this instance has the tag DownloadZipError.Tag.TOO_MANY_FILES, false otherwise.

Returns:

true if this instance is tagged as DownloadZipError.Tag.TOO_MANY_FILES, false otherwise.

isOther

public boolean isOther()

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

Returns:

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