Class SaveUrlError
- java.lang.Object
-
- com.dropbox.core.v2.files.SaveUrlError
-
public final class SaveUrlError 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
SaveUrlError.Tag
Discriminating tag type forSaveUrlError
.
-
Field Summary
Fields Modifier and Type Field Description static SaveUrlError
DOWNLOAD_FAILED
Failed downloading the given URL.static SaveUrlError
INVALID_URL
The given URL is invalid.static SaveUrlError
NOT_FOUND
The file where the URL is saved to no longer exists.static SaveUrlError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
WriteError
getPathValue()
This instance must be tagged asSaveUrlError.Tag.PATH
.int
hashCode()
boolean
isDownloadFailed()
boolean
isInvalidUrl()
boolean
isNotFound()
boolean
isOther()
boolean
isPath()
static SaveUrlError
path(WriteError value)
Returns an instance ofSaveUrlError
that has its tag set toSaveUrlError.Tag.PATH
.SaveUrlError.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
-
DOWNLOAD_FAILED
public static final SaveUrlError DOWNLOAD_FAILED
Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled.
-
INVALID_URL
public static final SaveUrlError INVALID_URL
The given URL is invalid.
-
NOT_FOUND
public static final SaveUrlError NOT_FOUND
The file where the URL is saved to no longer exists.
-
OTHER
public static final SaveUrlError 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 SaveUrlError.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 thisSaveUrlError
.If a tag returned by the server is unrecognized by this SDK, the
SaveUrlError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asSaveUrlError.Tag.PATH
,false
otherwise.
-
path
public static SaveUrlError path(WriteError value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
SaveUrlError
with its tag set toSaveUrlError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public WriteError getPathValue()
This instance must be tagged asSaveUrlError.Tag.PATH
.- Returns:
- The
WriteError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isDownloadFailed
public boolean isDownloadFailed()
- Returns:
true
if this instance is tagged asSaveUrlError.Tag.DOWNLOAD_FAILED
,false
otherwise.
-
isInvalidUrl
public boolean isInvalidUrl()
- Returns:
true
if this instance is tagged asSaveUrlError.Tag.INVALID_URL
,false
otherwise.
-
isNotFound
public boolean isNotFound()
- Returns:
true
if this instance is tagged asSaveUrlError.Tag.NOT_FOUND
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asSaveUrlError.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
-
-