Package com.dropbox.core.v2.files
Class SearchError
- java.lang.Object
-
- com.dropbox.core.v2.files.SearchError
-
public final class SearchError 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 classSearchError.TagDiscriminating tag type forSearchError.
-
Field Summary
Fields Modifier and Type Field Description static SearchErrorINTERNAL_ERRORSomething went wrong, please try again.static SearchErrorOTHERCatch-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 booleanequals(java.lang.Object obj)java.lang.StringgetInvalidArgumentValue()This instance must be tagged asSearchError.Tag.INVALID_ARGUMENT.LookupErrorgetPathValue()This instance must be tagged asSearchError.Tag.PATH.inthashCode()static SearchErrorinvalidArgument()Returns an instance ofSearchErrorthat has its tag set toSearchError.Tag.INVALID_ARGUMENT.static SearchErrorinvalidArgument(java.lang.String value)Returns an instance ofSearchErrorthat has its tag set toSearchError.Tag.INVALID_ARGUMENT.booleanisInternalError()booleanisInvalidArgument()booleanisOther()booleanisPath()static SearchErrorpath(LookupError value)Returns an instance ofSearchErrorthat has its tag set toSearchError.Tag.PATH.SearchError.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
-
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 aswitchstatement to properly handle the different values for thisSearchError.If a tag returned by the server is unrecognized by this SDK, the
SearchError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
trueif this instance is tagged asSearchError.Tag.PATH,falseotherwise.
-
path
public static SearchError path(LookupError value)
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
SearchErrorwith its tag set toSearchError.Tag.PATH. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getPathValue
public LookupError getPathValue()
This instance must be tagged asSearchError.Tag.PATH.- Returns:
- The
LookupErrorvalue associated with this instance ifisPath()istrue. - Throws:
java.lang.IllegalStateException- IfisPath()isfalse.
-
isInvalidArgument
public boolean isInvalidArgument()
- Returns:
trueif this instance is tagged asSearchError.Tag.INVALID_ARGUMENT,falseotherwise.
-
invalidArgument
public static SearchError invalidArgument(java.lang.String value)
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
SearchErrorwith its tag set toSearchError.Tag.INVALID_ARGUMENT.
-
invalidArgument
public static SearchError invalidArgument()
- Returns:
- Instance of
SearchErrorwith its tag set toSearchError.Tag.INVALID_ARGUMENT.
-
getInvalidArgumentValue
public java.lang.String getInvalidArgumentValue()
This instance must be tagged asSearchError.Tag.INVALID_ARGUMENT.- Returns:
- The
Stringvalue associated with this instance ifisInvalidArgument()istrue. - Throws:
java.lang.IllegalStateException- IfisInvalidArgument()isfalse.
-
isInternalError
public boolean isInternalError()
- Returns:
trueif this instance is tagged asSearchError.Tag.INTERNAL_ERROR,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asSearchError.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
-
-