Package com.dropbox.core.v2.fileproperties

Class PropertiesSearchMode

java.lang.Object

com.dropbox.core.v2.fileproperties.PropertiesSearchMode

public final class PropertiesSearchMode
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	PropertiesSearchMode.Tag	Discriminating tag type for PropertiesSearchMode.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static PropertiesSearchMode	fieldName(String value)	Returns an instance of PropertiesSearchMode that has its tag set to PropertiesSearchMode.Tag.FIELD_NAME.
String	getFieldNameValue()	Search for a value associated with this field name.
int	hashCode()
boolean	isFieldName()	Returns true if this instance has the tag PropertiesSearchMode.Tag.FIELD_NAME, false otherwise.
boolean	isOther()	Returns true if this instance has the tag PropertiesSearchMode.Tag.OTHER, false otherwise.
PropertiesSearchMode.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 PropertiesSearchMode 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 PropertiesSearchMode.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 PropertiesSearchMode.

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

Returns:

the tag for this instance.

isFieldName

public boolean isFieldName()

Returns true if this instance has the tag PropertiesSearchMode.Tag.FIELD_NAME, false otherwise.

Returns:

true if this instance is tagged as PropertiesSearchMode.Tag.FIELD_NAME, false otherwise.

fieldName

public static PropertiesSearchMode fieldName(String value)

Returns an instance of PropertiesSearchMode that has its tag set to PropertiesSearchMode.Tag.FIELD_NAME.

Search for a value associated with this field name.

Parameters:

value - value to assign to this instance.

Returns:

Instance of PropertiesSearchMode with its tag set to PropertiesSearchMode.Tag.FIELD_NAME.

Throws:

IllegalArgumentException - if value is null.

getFieldNameValue

public String getFieldNameValue()

Search for a value associated with this field name.

This instance must be tagged as PropertiesSearchMode.Tag.FIELD_NAME.

Returns:

The String value associated with this instance if isFieldName() is true.

Throws:

IllegalStateException - If isFieldName() is false.

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as PropertiesSearchMode.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