Package com.dropbox.core.v2.fileproperties

Class PropertiesSearchError

java.lang.Object

com.dropbox.core.v2.fileproperties.PropertiesSearchError

public final class PropertiesSearchError
extends 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	Description
static enum	PropertiesSearchError.Tag	Discriminating tag type for PropertiesSearchError.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LookUpPropertiesError	getPropertyGroupLookupValue()	This instance must be tagged as PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP.
int	hashCode()
boolean	isOther()	Returns true if this instance has the tag PropertiesSearchError.Tag.OTHER, false otherwise.
boolean	isPropertyGroupLookup()	Returns true if this instance has the tag PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.
static PropertiesSearchError	propertyGroupLookup(LookUpPropertiesError value)	Returns an instance of PropertiesSearchError that has its tag set to PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP.
PropertiesSearchError.Tag	tag()	Returns the tag for this instance.
String	toString()
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 Details

OTHER

public static final PropertiesSearchError 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 Details

tag

public PropertiesSearchError.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 PropertiesSearchError.

If a tag returned by the server is unrecognized by this SDK, the PropertiesSearchError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isPropertyGroupLookup

public boolean isPropertyGroupLookup()

Returns true if this instance has the tag PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.

Returns:

true if this instance is tagged as PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP, false otherwise.

propertyGroupLookup

public static PropertiesSearchError propertyGroupLookup(LookUpPropertiesError value)

Returns an instance of PropertiesSearchError that has its tag set to PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of PropertiesSearchError with its tag set to PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP.

Throws:

IllegalArgumentException - if value is null.

getPropertyGroupLookupValue

public LookUpPropertiesError getPropertyGroupLookupValue()

This instance must be tagged as PropertiesSearchError.Tag.PROPERTY_GROUP_LOOKUP.

Returns:

The LookUpPropertiesError value associated with this instance if isPropertyGroupLookup() is true.

Throws:

IllegalStateException - If isPropertyGroupLookup() is false.

isOther

public boolean isOther()

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

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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