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 theisAbc()
methods will returntrue
. You can usetag()
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 class
DownloadZipError.Tag
Discriminating tag type forDownloadZipError
.
-
Field Summary
Fields Modifier and Type Field 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
LookupError
getPathValue()
This instance must be tagged asDownloadZipError.Tag.PATH
.int
hashCode()
boolean
isOther()
boolean
isPath()
boolean
isTooLarge()
boolean
isTooManyFiles()
static DownloadZipError
path(LookupError value)
Returns an instance ofDownloadZipError
that has its tag set toDownloadZipError.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.
-
-
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisDownloadZipError
.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 is tagged asDownloadZipError.Tag.PATH
,false
otherwise.
-
path
public static DownloadZipError path(LookupError value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
DownloadZipError
with its tag set toDownloadZipError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asDownloadZipError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isTooLarge
public boolean isTooLarge()
- Returns:
true
if this instance is tagged asDownloadZipError.Tag.TOO_LARGE
,false
otherwise.
-
isTooManyFiles
public boolean isTooManyFiles()
- Returns:
true
if this instance is tagged asDownloadZipError.Tag.TOO_MANY_FILES
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asDownloadZipError.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.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
-
-