Package com.dropbox.core.v2.files
Class SearchError
- java.lang.Object
-
- com.dropbox.core.v2.files.SearchError
-
public final class SearchError 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
SearchError.Tag
Discriminating tag type forSearchError
.
-
Field Summary
Fields Modifier and Type Field Description static SearchError
INTERNAL_ERROR
Something went wrong, please try again.static SearchError
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)
java.lang.String
getInvalidArgumentValue()
This instance must be tagged asSearchError.Tag.INVALID_ARGUMENT
.LookupError
getPathValue()
This instance must be tagged asSearchError.Tag.PATH
.int
hashCode()
static SearchError
invalidArgument()
Returns an instance ofSearchError
that has its tag set toSearchError.Tag.INVALID_ARGUMENT
.static SearchError
invalidArgument(java.lang.String value)
Returns an instance ofSearchError
that has its tag set toSearchError.Tag.INVALID_ARGUMENT
.boolean
isInternalError()
boolean
isInvalidArgument()
boolean
isOther()
boolean
isPath()
static SearchError
path(LookupError value)
Returns an instance ofSearchError
that has its tag set toSearchError.Tag.PATH
.SearchError.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
-
INTERNAL_ERROR
public static final SearchError INTERNAL_ERROR
Something went wrong, please try again.
-
OTHER
public static final SearchError 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 SearchError.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 thisSearchError
.If a tag returned by the server is unrecognized by this SDK, the
SearchError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
true
if this instance is tagged asSearchError.Tag.PATH
,false
otherwise.
-
path
public static SearchError path(LookupError value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
SearchError
with its tag set toSearchError.Tag.PATH
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asSearchError.Tag.PATH
.- Returns:
- The
LookupError
value associated with this instance ifisPath()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisPath()
isfalse
.
-
isInvalidArgument
public boolean isInvalidArgument()
- Returns:
true
if this instance is tagged asSearchError.Tag.INVALID_ARGUMENT
,false
otherwise.
-
invalidArgument
public static SearchError invalidArgument(java.lang.String value)
- Parameters:
value
- value to assign to this instance.- Returns:
- Instance of
SearchError
with its tag set toSearchError.Tag.INVALID_ARGUMENT
.
-
invalidArgument
public static SearchError invalidArgument()
- Returns:
- Instance of
SearchError
with its tag set toSearchError.Tag.INVALID_ARGUMENT
.
-
getInvalidArgumentValue
public java.lang.String getInvalidArgumentValue()
This instance must be tagged asSearchError.Tag.INVALID_ARGUMENT
.- Returns:
- The
String
value associated with this instance ifisInvalidArgument()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisInvalidArgument()
isfalse
.
-
isInternalError
public boolean isInternalError()
- Returns:
true
if this instance is tagged asSearchError.Tag.INTERNAL_ERROR
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asSearchError.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
-
-