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 the isAbc() methods will return true. You can use tag() 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 and Description
static class	SearchError.Tag Discriminating tag type for SearchError.

Field Summary

Fields

Modifier and Type	Field and Description
static SearchError	OTHER Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
LookupError	getPathValue() This instance must be tagged as SearchError.Tag.PATH.
int	hashCode()
boolean	isOther() Returns true if this instance has the tag SearchError.Tag.OTHER, false otherwise.
boolean	isPath() Returns true if this instance has the tag SearchError.Tag.PATH, false otherwise.
static SearchError	path(LookupError value) Returns an instance of SearchError that has its tag set to SearchError.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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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 return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this SearchError.

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 has the tag SearchError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as SearchError.Tag.PATH, false otherwise.

path

public static SearchError path(LookupError value)

Returns an instance of SearchError that has its tag set to SearchError.Tag.PATH.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of SearchError with its tag set to SearchError.Tag.PATH.

Throws:

java.lang.IllegalArgumentException - if value is null.

getPathValue

public LookupError getPathValue()

This instance must be tagged as SearchError.Tag.PATH.

Returns:

The LookupError value associated with this instance if isPath() is true.

Throws:

java.lang.IllegalStateException - If isPath() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag SearchError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as SearchError.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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