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 SummaryNested Classes Modifier and Type Class Description static classSearchError.TagDiscriminating tag type forSearchError.
 - 
Field SummaryFields 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 SummaryAll 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_ERRORpublic static final SearchError INTERNAL_ERROR Something went wrong, please try again.
 - 
OTHERpublic 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- 
tagpublic 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.
 
 - 
isPathpublic boolean isPath() - Returns:
- trueif this instance is tagged as- SearchError.Tag.PATH,- falseotherwise.
 
 - 
pathpublic 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- if- valueis- null.
 
 - 
getPathValuepublic LookupError getPathValue() This instance must be tagged asSearchError.Tag.PATH.- Returns:
- The LookupErrorvalue associated with this instance ifisPath()istrue.
- Throws:
- java.lang.IllegalStateException- If- isPath()is- false.
 
 - 
isInvalidArgumentpublic boolean isInvalidArgument() - Returns:
- trueif this instance is tagged as- SearchError.Tag.INVALID_ARGUMENT,- falseotherwise.
 
 - 
invalidArgumentpublic 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.
 
 - 
invalidArgumentpublic static SearchError invalidArgument() - Returns:
- Instance of SearchErrorwith its tag set toSearchError.Tag.INVALID_ARGUMENT.
 
 - 
getInvalidArgumentValuepublic 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- If- isInvalidArgument()is- false.
 
 - 
isInternalErrorpublic boolean isInternalError() - Returns:
- trueif this instance is tagged as- SearchError.Tag.INTERNAL_ERROR,- falseotherwise.
 
 - 
isOtherpublic boolean isOther() - Returns:
- trueif this instance is tagged as- SearchError.Tag.OTHER,- falseotherwise.
 
 - 
hashCodepublic int hashCode() - Overrides:
- hashCodein class- java.lang.Object
 
 - 
equalspublic boolean equals(java.lang.Object obj) - Overrides:
- equalsin class- java.lang.Object
 
 - 
toStringpublic java.lang.String toString() - Overrides:
- toStringin class- java.lang.Object
 
 - 
toStringMultilinepublic 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
 
 
- 
 
-