Class DownloadError
- java.lang.Object
-
- com.dropbox.core.v2.files.DownloadError
-
public final class DownloadError extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDownloadError.TagDiscriminating tag type forDownloadError.
-
Field Summary
Fields Modifier and Type Field Description static DownloadErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static DownloadErrorUNSUPPORTED_FILEThis file type cannot be downloaded directly; useDbxUserFilesRequests.export(String,String)instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)LookupErrorgetPathValue()This instance must be tagged asDownloadError.Tag.PATH.inthashCode()booleanisOther()booleanisPath()booleanisUnsupportedFile()static DownloadErrorpath(LookupError value)Returns an instance ofDownloadErrorthat has its tag set toDownloadError.Tag.PATH.DownloadError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
UNSUPPORTED_FILE
public static final DownloadError UNSUPPORTED_FILE
This file type cannot be downloaded directly; useDbxUserFilesRequests.export(String,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 returntrue. Callers are recommended to use the tag value in aswitchstatement to properly handle the different values for thisDownloadError.If a tag returned by the server is unrecognized by this SDK, the
DownloadError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
trueif this instance is tagged asDownloadError.Tag.PATH,falseotherwise.
-
path
public static DownloadError path(LookupError value)
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
DownloadErrorwith its tag set toDownloadError.Tag.PATH. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asDownloadError.Tag.PATH.- Returns:
- The
LookupErrorvalue associated with this instance ifisPath()istrue. - Throws:
java.lang.IllegalStateException- IfisPath()isfalse.
-
isUnsupportedFile
public boolean isUnsupportedFile()
- Returns:
trueif this instance is tagged asDownloadError.Tag.UNSUPPORTED_FILE,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asDownloadError.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-